Analytics Opt-Out #862

Author: EddyVerbruggen

demo/app/main-page.xml

@@ -81,7 +81,7 @@
       <TabViewItem.view>
         <ScrollView>
           <GridLayout columns="*, *"
-                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
+                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
                       horizontalAlignment="stretch"
                       class="tab-content">
 
@@ -169,45 +169,48 @@
 
             <Label row="30" colSpan="2" text="Analytics" class="subtitle"/>
 
-            <Button row="31" col="0" text="log event" tap="{{ doLogAnalyticsEvent }}" class="button button-analytics"/>
-            <Button row="31" col="1" text="set user property" tap="{{ doSetAnalyticsUserProperty }}" class="button button-analytics"/>
+            <Button row="31" col="0" text="collection on" tap="{{ doEnableAnalytics }}" class="button button-analytics"/>
+            <Button row="31" col="1" text="collection off" tap="{{ doDisableAnalytics }}" class="button button-analytics"/>
 
-            <Button row="32" col="0" text="set Screen A" tap="{{ doSetScreenNameA }}" class="button button-analytics"/>
-            <Button row="32" col="1" text="set Screen B" tap="{{ doSetScreenNameB }}" class="button button-analytics"/>
+            <Button row="32" col="0" text="log event" tap="{{ doLogAnalyticsEvent }}" class="button button-analytics"/>
+            <Button row="32" col="1" text="set user property" tap="{{ doSetAnalyticsUserProperty }}" class="button button-analytics"/>
 
-            <Label row="33" colSpan="2" text="AdMob" class="subtitle"/>
+            <Button row="33" col="0" text="set Screen A" tap="{{ doSetScreenNameA }}" class="button button-analytics"/>
+            <Button row="33" col="1" text="set Screen B" tap="{{ doSetScreenNameB }}" class="button button-analytics"/>
 
-            <Button row="34" col="0" text="show banner" tap="{{ doShowAdMobBanner }}" class="button button-admob"/>
-            <Button row="34" col="1" text="show interstitial" tap="{{ doShowAdMobInterstitial }}" class="button button-admob"/>
+            <Label row="34" colSpan="2" text="AdMob" class="subtitle"/>
 
-            <Button row="35" colSpan="2" text="hide banner" tap="{{ doHideAdMobBanner }}" class="button button-admob"/>
+            <Button row="35" col="0" text="show banner" tap="{{ doShowAdMobBanner }}" class="button button-admob"/>
+            <Button row="35" col="1" text="show interstitial" tap="{{ doShowAdMobInterstitial }}" class="button button-admob"/>
 
-            <Label row="36" colSpan="2" text="Firebase Cloud Messaging" class="subtitle"/>
+            <Button row="36" colSpan="2" text="hide banner" tap="{{ doHideAdMobBanner }}" class="button button-admob"/>
 
-            <Button row="37" col="0" text="add push handlers" tap="{{ messaging.doRegisterPushHandlers }}" class="button button-messaging"/>
-            <Button row="37" col="1" text="get current token" tap="{{ messaging.doGetCurrentPushToken }}" class="button button-messaging"/>
+            <Label row="37" colSpan="2" text="Firebase Cloud Messaging" class="subtitle"/>
 
-            <Button row="38" col="0" text="topic subscribe" tap="{{ messaging.doSubscribeToTopic }}" class="button button-messaging"/>
-            <Button row="38" col="1" text="topic unsubscribe" tap="{{ messaging.doUnsubscribeFromTopic }}" class="button button-messaging"/>
+            <Button row="38" col="0" text="add push handlers" tap="{{ messaging.doRegisterPushHandlers }}" class="button button-messaging"/>
+            <Button row="38" col="1" text="get current token" tap="{{ messaging.doGetCurrentPushToken }}" class="button button-messaging"/>
+
+            <Button row="39" col="0" text="topic subscribe" tap="{{ messaging.doSubscribeToTopic }}" class="button button-messaging"/>
+            <Button row="39" col="1" text="topic unsubscribe" tap="{{ messaging.doUnsubscribeFromTopic }}" class="button button-messaging"/>
             <iOS>
-              <Button row="39" colSpan="2" text="register interactive push" tap="{{ messaging.doRegisterForInteractivePush }}" class="button button-messaging"/>
+              <Button row="40" colSpan="2" text="register interactive push" tap="{{ messaging.doRegisterForInteractivePush }}" class="button button-messaging"/>
             </iOS>
-            <Button row="40" colSpan="2" text="are notifications enabled" tap="{{ messaging.doGetAreNotificationsEnabled }}" class="button button-messaging"/>
+            <Button row="41" colSpan="2" text="are notifications enabled" tap="{{ messaging.doGetAreNotificationsEnabled }}" class="button button-messaging"/>
             <!-- <Button row="39" col="1" text="topic unsubscribe" tap="{{ doUnsubscribeFromTopic }}" class="button button-messaging"/> -->
 
-            <Label row="41" colSpan="2" text="Firebase Crash Reporing / Crashlytics" class="subtitle"/>
+            <Label row="42" colSpan="2" text="Firebase Crash Reporing / Crashlytics" class="subtitle"/>
 
-            <Button row="42" col="0" text="log message" tap="{{ doLogMessage }}" class="button button-crash"/>
+            <Button row="43" col="0" text="log message" tap="{{ doLogMessage }}" class="button button-crash"/>
             <iOS>
-              <Button row="42" col="1" text="force crash :)" tap="{{ doForceCrashIOS }}" class="button button-crash"/>
+              <Button row="43" col="1" text="force crash :)" tap="{{ doForceCrashIOS }}" class="button button-crash"/>
             </iOS>
             <Android>
-              <Button row="42" col="1" text="force crash :)" tap="{{ doForceCrashAndroid }}" class="button button-crash"/>
+              <Button row="43" col="1" text="force crash :)" tap="{{ doForceCrashAndroid }}" class="button button-crash"/>
             </Android>
 
-            <Label row="43" colSpan="2" text="Firebase Invites" class="subtitle"/>
-            <Button row="44" col="0" text="send invitation" tap="{{ sendInvitation }}" class="button button-invites"/>
-            <Button row="44" col="1" text="get invitation" tap="{{ getInvitation }}" class="button button-invites"/>
+            <Label row="44" colSpan="2" text="Firebase Invites" class="subtitle"/>
+            <Button row="45" col="0" text="send invitation" tap="{{ sendInvitation }}" class="button button-invites"/>
+            <Button row="45" col="1" text="get invitation" tap="{{ getInvitation }}" class="button button-invites"/>
           </GridLayout>
 
         </ScrollView>

demo/app/main-view-model.ts

@@ -378,6 +378,7 @@ export class HelloWorldModel extends Observable {
     firebase.init({
       // storageBucket: 'gs://n-plugin-test.appspot.com',
       persist: true, // optional, default false
+      analyticsCollectionEnabled: true,
       onAuthStateChanged: data => { // optional
         console.log((data.loggedIn ? "Logged in to firebase" : "Logged out from firebase") + " (init's onAuthStateChanged callback)");
         if (data.loggedIn) {
@@ -427,6 +428,24 @@ export class HelloWorldModel extends Observable {
     );
   }
 
+  public doEnableAnalytics(): void {
+    firebase.analytics.setAnalyticsCollectionEnabled(true);
+    alert({
+      title: "Analytics collection",
+      message: "ENABLED",
+      okButtonText: "OK"
+    });
+  }
+
+  public doDisableAnalytics(): void {
+    firebase.analytics.setAnalyticsCollectionEnabled(false);
+    alert({
+      title: "Analytics collection",
+      message: "DISABLED",
+      okButtonText: "OK"
+    });
+  }
+
   public doLogAnalyticsEvent(): void {
     firebase.analytics.logEvent({
       // see https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event.html

docs/ANALYTICS.md

@@ -81,3 +81,21 @@ Want to log a user ID with your analytics data? Go ahead:
       }
   );
 ```
+
+### analytics.setAnalyticsCollectionEnabled
+By default Firebase collects analytics data. If you don't want this (or first get user consent),
+you can disable/enable this at runtime:
+
+```js
+  firebase.analytics.setAnalyticsCollectionEnabled(false);
+```
+
+You can also pass this property during `init()`:
+
+```typescript
+  firebase.init({
+    analyticsCollectionEnabled: false
+  });
+```
+
+> If you want to disable collection without calling this function programmatically, then you can add a flag to your `App_Resources/iOS/Info.plist` and `App_Resources/Android/AndroidManifest.xml`, see [Firebase's documentation](https://firebase.google.com/support/guides/disable-analytics) for details.

src/analytics/analytics.android.ts

@@ -22,7 +22,7 @@ export function logEvent(options: LogEventOptions): Promise<void> {
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-        appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
       ).logEvent(options.key, bundle);
 
       resolve();
@@ -64,7 +64,7 @@ export function setUserProperty(options: SetUserPropertyOptions): Promise<void>
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-        appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
       ).setUserProperty(options.key, options.value);
 
       resolve();
@@ -84,7 +84,7 @@ export function setScreenName(options: SetScreenNameOptions): Promise<void> {
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-        appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
       ).setCurrentScreen(appModule.android.foregroundActivity, options.screenName, null);
 
       resolve();
@@ -94,3 +94,9 @@ 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()
+  ).setAnalyticsCollectionEnabled(enabled);
+}

src/analytics/analytics.d.ts

@@ -43,3 +43,5 @@ export declare function setUserId(options: SetUserIdOptions): Promise<void>;
 export declare function setUserProperty(options: SetUserPropertyOptions): Promise<void>;
 
 export declare function setScreenName(options: SetScreenNameOptions): Promise<void>;
+
+export declare function setAnalyticsCollectionEnabled(enabled: boolean): void;

src/analytics/analytics.ios.ts

@@ -85,3 +85,7 @@ export function setScreenName(options: SetScreenNameOptions): Promise<void> {
     }
   });
 }
+
+export function setAnalyticsCollectionEnabled(enabled: boolean): void {
+  FIRAnalyticsConfiguration.sharedInstance().setAnalyticsCollectionEnabled(enabled);
+}

src/firebase.android.ts

@@ -261,6 +261,10 @@ firebase.init = arg => {
     const runInit = () => {
       arg = arg || {};
 
+      com.google.firebase.analytics.FirebaseAnalytics.getInstance(
+          appModule.android.currentContext || 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

@@ -79,6 +79,12 @@ export enum ServerValue {
  * The options object passed into the init function.
  */
 export interface InitOptions {
+  /**
+   * Allow the app to send analytics data to Firebase.
+   * Can also be set later with analytics.setAnalyticsCollectionEnabled.
+   * Default true.
+   */
+  analyticsCollectionEnabled?: boolean;
   /**
    * Allow disk persistence. Default true for Firestore, false for regular Firebase DB.
    */

src/firebase.ios.ts

@@ -341,6 +341,8 @@ firebase.init = arg => {
         FIROptions.defaultOptions().deepLinkURLScheme = iOSUtils.getter(NSBundle, NSBundle.mainBundle).bundleIdentifier;
       }
 
+      FIRAnalyticsConfiguration.sharedInstance().setAnalyticsCollectionEnabled(arg.analyticsCollectionEnabled || false);
+
       if (!firebase._configured) {
         firebase._configured = true;
         FIRApp.configure();