firebase · VinayGuthal · Jul 31, 2020 · Apr 7, 2020 · Apr 7, 2020 · Apr 8, 2020
diff --git a/firebase-crashlytics/api.txt b/firebase-crashlytics/api.txt
@@ -10,6 +10,7 @@ package com.google.firebase.crashlytics {
     method public void recordException(@NonNull Throwable);
     method public void sendUnsentReports();
     method public void setCrashlyticsCollectionEnabled(boolean);
+    method public void setCrashlyticsCollectionEnabled(@Nullable Boolean);
     method public void setCustomKey(@NonNull String, boolean);
     method public void setCustomKey(@NonNull String, double);
     method public void setCustomKey(@NonNull String, float);

diff --git a/...dTest/java/com/google/firebase/crashlytics/internal/common/CrashlyticsControllerTest.java b/...dTest/java/com/google/firebase/crashlytics/internal/common/CrashlyticsControllerTest.java
@@ -828,6 +828,7 @@ public void testUploadDisabledThenEnabled() throws Exception {
 
     // Use a real DataCollectionArbiter to test its switching behavior.
     DataCollectionArbiter arbiter = new DataCollectionArbiter(app);
+    assertFalse(arbiter.isAutomaticDataCollectionEnabled());
 
     final ControllerBuilder builder = builder();
     builder.setDataCollectionArbiter(arbiter);
@@ -838,6 +839,21 @@ public void testUploadDisabledThenEnabled() throws Exception {
     Task<Void> task = controller.submitAllReports(1.0f, testSettingsDataProvider.getAppSettings());
 
     arbiter.setCrashlyticsDataCollectionEnabled(true);
+    assertTrue(arbiter.isAutomaticDataCollectionEnabled());
+
+    when(mockEditor.putBoolean(PREFS_KEY, false)).thenReturn(mockEditor);
+    when(mockPrefs.getBoolean(PREFS_KEY, true)).thenReturn(false);
+    arbiter.setCrashlyticsDataCollectionEnabled(false);
+    assertFalse(arbiter.isAutomaticDataCollectionEnabled());
+
+    when(mockPrefs.contains(PREFS_KEY)).thenReturn(false);
+    when(mockEditor.remove(PREFS_KEY)).thenReturn(mockEditor);
+    arbiter.setCrashlyticsDataCollectionEnabled(null);
+    when(app.isDataCollectionDefaultEnabled()).thenReturn(true);
+    assertTrue(arbiter.isAutomaticDataCollectionEnabled());
+    when(app.isDataCollectionDefaultEnabled()).thenReturn(false);
+    assertFalse(arbiter.isAutomaticDataCollectionEnabled());
+
     await(task);
     verify(mockReportManager).areReportsAvailable();
     verify(mockReportManager).findReports();

diff --git a/firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java b/firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java
@@ -463,4 +463,23 @@ public boolean didCrashOnPreviousExecution() {
   public void setCrashlyticsCollectionEnabled(boolean enabled) {
     core.setCrashlyticsCollectionEnabled(enabled);
   }
+
+  /**
+   * Enables/disables/clears automatic data collection config by Crashlytics.
+   *
+   * <p>If this is set, it overrides the data collection settings provided by the Android Manifest,
+   * as well as any Firebase-wide automatic data collection settings.
+   *
+   * <p>If automatic data collection is disabled for Crashlytics, crash reports are stored on the
+   * device. To check for reports, use the {@link #checkForUnsentReports()} method. Use {@link
+   * #sendUnsentReports()} to upload existing reports even when automatic data collection is
+   * disabled. Use {@link #deleteUnsentReports()} to delete any reports stored on the device without
+   * sending them to Crashlytics.
+   *
+   * @param enabled whether to enable automatic data collection. The value of null would clear the
+   *     Crashlytics config and the enablement of data collection would depend on other settings.
+   */
+  public void setCrashlyticsCollectionEnabled(@Nullable Boolean enabled) {
+    core.setCrashlyticsCollectionEnabled(enabled);
+  }
 }
diff --git a/...lytics/src/main/java/com/google/firebase/crashlytics/internal/common/CrashlyticsCore.java b/...lytics/src/main/java/com/google/firebase/crashlytics/internal/common/CrashlyticsCore.java
@@ -247,7 +247,7 @@ private Task<Void> doBackgroundInitialization(SettingsDataProvider settingsProvi
 
   // endregion
 
-  public void setCrashlyticsCollectionEnabled(boolean enabled) {
+  public void setCrashlyticsCollectionEnabled(Boolean enabled) {
     dataCollectionArbiter.setCrashlyticsDataCollectionEnabled(enabled);
   }
 

diff --git a/.../src/main/java/com/google/firebase/crashlytics/internal/common/DataCollectionArbiter.java b/.../src/main/java/com/google/firebase/crashlytics/internal/common/DataCollectionArbiter.java
@@ -29,15 +29,15 @@ public class DataCollectionArbiter {
   private static final String FIREBASE_CRASHLYTICS_COLLECTION_ENABLED =
       "firebase_crashlytics_collection_enabled";
 
+  private final SharedPreferences sharedPreferences;
+  private final FirebaseApp firebaseApp;
+
   // State for waitForDataCollectionEnabled().
-  private Object taskLock = new Object();
+  private final Object taskLock = new Object();
   TaskCompletionSource<Void> dataCollectionEnabledTask = new TaskCompletionSource<>();
   boolean taskResolved = false;
 
-  private final SharedPreferences sharedPreferences;
-  private volatile boolean crashlyticsDataCollectionExplicitlySet;
-  private volatile boolean crashlyticsDataCollectionEnabled;
-  private final FirebaseApp firebaseApp;
+  private Boolean crashlyticsDataCollectionEnabled;
 
   /**
    * A Task that will be resolved when explicit data collection permission is granted by calling
@@ -47,43 +47,17 @@ public class DataCollectionArbiter {
       new TaskCompletionSource<>();
 
   public DataCollectionArbiter(FirebaseApp app) {
-    this.firebaseApp = app;
-    Context applicationContext = app.getApplicationContext();
-    if (applicationContext == null) {
-      throw new RuntimeException("null context");
-    }
+    final Context applicationContext = app.getApplicationContext();
 
+    firebaseApp = app;
     sharedPreferences = CommonUtils.getSharedPrefs(applicationContext);
 
-    boolean enabled = true;
-    boolean explicitlySet = false;
-
-    if (sharedPreferences.contains(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
-      enabled = sharedPreferences.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED, true);
-      explicitlySet = true;
-    } else {
-      try {
-        final PackageManager packageManager = applicationContext.getPackageManager();
-        if (packageManager != null) {
-          final ApplicationInfo applicationInfo =
-              packageManager.getApplicationInfo(
-                  applicationContext.getPackageName(), PackageManager.GET_META_DATA);
-          if (applicationInfo != null
-              && applicationInfo.metaData != null
-              && applicationInfo.metaData.containsKey(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
-            enabled = applicationInfo.metaData.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED);
-            explicitlySet = true;
-          }
-        }
-      } catch (PackageManager.NameNotFoundException e) {
-        // This shouldn't happen since it's this app's package, but fall through to default
-        // if so.
-        Logger.getLogger().d("Unable to get PackageManager. Falling through", e);
-      }
+    Boolean dataCollectionEnabled = getDataCollectionValueFromSharedPreferences(sharedPreferences);
+    if (dataCollectionEnabled == null) {
+      dataCollectionEnabled = getDataCollectionValueFromManifest(applicationContext);
     }
 
-    crashlyticsDataCollectionEnabled = enabled;
-    crashlyticsDataCollectionExplicitlySet = explicitlySet;
+    crashlyticsDataCollectionEnabled = dataCollectionEnabled;
 
     synchronized (taskLock) {
       if (isAutomaticDataCollectionEnabled()) {
@@ -93,27 +67,21 @@ public DataCollectionArbiter(FirebaseApp app) {
     }
   }
 
-  public boolean isAutomaticDataCollectionEnabled() {
-    if (crashlyticsDataCollectionExplicitlySet) {
-      return crashlyticsDataCollectionEnabled;
-    }
-    return firebaseApp.isDataCollectionDefaultEnabled();
-  }
-
-  public Task<Void> waitForAutomaticDataCollectionEnabled() {
-    synchronized (taskLock) {
-      return dataCollectionEnabledTask.getTask();
-    }
+  public synchronized boolean isAutomaticDataCollectionEnabled() {
+    return crashlyticsDataCollectionEnabled != null
+        ? crashlyticsDataCollectionEnabled
+        : firebaseApp.isDataCollectionDefaultEnabled();
   }
 
-  @SuppressLint({"CommitPrefEdits", "ApplySharedPref"})
-  public void setCrashlyticsDataCollectionEnabled(boolean enabled) {
-    crashlyticsDataCollectionEnabled = enabled;
-    crashlyticsDataCollectionExplicitlySet = true;
-    sharedPreferences.edit().putBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED, enabled).commit();
+  public synchronized void setCrashlyticsDataCollectionEnabled(Boolean enabled) {
+    crashlyticsDataCollectionEnabled =
+        (enabled != null)
+            ? enabled
+            : getDataCollectionValueFromManifest(firebaseApp.getApplicationContext());
+    storeDataCollectionValueInSharedPreferences(sharedPreferences, enabled);
 
     synchronized (taskLock) {
-      if (enabled) {
+      if (isAutomaticDataCollectionEnabled()) {
         if (!taskResolved) {
           dataCollectionEnabledTask.trySetResult(null);
           taskResolved = true;
@@ -127,6 +95,12 @@ public void setCrashlyticsDataCollectionEnabled(boolean enabled) {
     }
   }
 
+  public Task<Void> waitForAutomaticDataCollectionEnabled() {
+    synchronized (taskLock) {
+      return dataCollectionEnabledTask.getTask();
+    }
+  }
+
   /**
    * Returns a task which will be resolved when either: 1) automatic data collection has been
    * enabled, or 2) grantDataCollectionPermission has been called.
@@ -150,4 +124,55 @@ public void grantDataCollectionPermission(boolean dataCollectionToken) {
     }
     dataCollectionExplicitlyApproved.trySetResult(null);
   }
+
+  @SuppressLint({"ApplySharedPref"})
+  private static void storeDataCollectionValueInSharedPreferences(
+      SharedPreferences sharedPreferences, Boolean enabled) {
+    final SharedPreferences.Editor prefsEditor = sharedPreferences.edit();
+    if (enabled != null) {
+      prefsEditor.putBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED, enabled);
+    } else {
+      prefsEditor.remove(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED);
+    }
+    prefsEditor.commit();
+  }
+
+  private static Boolean getDataCollectionValueFromSharedPreferences(
+      SharedPreferences sharedPreferences) {
+    if (sharedPreferences.contains(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
+      return sharedPreferences.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED, true);
+    }
+    return null;
+  }
+
+  private static Boolean getDataCollectionValueFromManifest(Context applicationContext) {
+    final Boolean manifestSetting =
+        readCrashlyticsDataCollectionEnabledFromManifest(applicationContext);
+    if (manifestSetting == null) {
+      return null;
+    }
+    return Boolean.TRUE.equals(manifestSetting);
+  }
+
+  private static Boolean readCrashlyticsDataCollectionEnabledFromManifest(
+      Context applicationContext) {
+    try {
+      final PackageManager packageManager = applicationContext.getPackageManager();
+      if (packageManager != null) {
+        final ApplicationInfo applicationInfo =
+            packageManager.getApplicationInfo(
+                applicationContext.getPackageName(), PackageManager.GET_META_DATA);
+        if (applicationInfo != null
+            && applicationInfo.metaData != null
+            && applicationInfo.metaData.containsKey(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
+          return applicationInfo.metaData.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED);
+        }
+      }
+    } catch (PackageManager.NameNotFoundException e) {
+      // This shouldn't happen since it's this app's package, but fall through to default
+      // if so.
+      Logger.getLogger().d("Unable to get PackageManager. Falling through", e);
+    }
+    return null;
+  }
 }