Update logging flag to match recommended style and execution. (#2392)

* Update logging flag to match recommended style and execution.

* Update logging flag to match recommended style and execution.

* Updating statCollection name based on review feedback

* Updating to Boolean and handling null edge case for collection method..

* fix formatting post merge

Author: annzimmer

firebase-ml-modeldownloader/api.txt

@@ -62,7 +62,7 @@ package com.google.firebase.ml.modeldownloader {
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.ml.modeldownloader.CustomModel> getModel(@NonNull String, @NonNull com.google.firebase.ml.modeldownloader.DownloadType, @Nullable com.google.firebase.ml.modeldownloader.CustomModelDownloadConditions);
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Long> getModelDownloadId(@NonNull String, @Nullable com.google.android.gms.tasks.Task<com.google.firebase.ml.modeldownloader.CustomModel>);
     method @NonNull public com.google.android.gms.tasks.Task<java.util.Set<com.google.firebase.ml.modeldownloader.CustomModel>> listDownloadedModels();
-    method public void setStatsCollectionEnabled(boolean);
+    method public void setModelDownloaderCollectionEnabled(@Nullable Boolean);
   }
 
 }

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/FirebaseModelDownloader.java

@@ -484,9 +484,10 @@ private boolean deleteModelDetails(@NonNull String modelName) {
    *
    * <p>By default the logging matches the Firebase wide data collection switch.
    *
-   * @param enabled - is statistics logging enabled
+   * @param enabled - is logging enabled, set to null to use Firebase wide data collection switch
+   *     (default)
    */
-  public void setStatsCollectionEnabled(boolean enabled) {
+  public void setModelDownloaderCollectionEnabled(@Nullable Boolean enabled) {
     sharedPreferencesUtil.setCustomModelStatsCollectionEnabled(enabled);
   }
 

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/internal/SharedPreferencesUtil.java

@@ -253,25 +253,38 @@ public synchronized Set<CustomModel> listDownloadedModels() {
   /**
    * Should Firelog logging be enabled.
    *
-   * @return whether or not firelog events should be logged. Default to true.
+   * @return whether or not firelog events should be logged. If not specifically set, defaults to fi
    */
   public synchronized boolean getCustomModelStatsCollectionFlag() {
-    return getSharedPreferences()
-        .getBoolean(
-            String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey), true);
+    if (getSharedPreferences()
+        .contains(String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey))) {
+      return getSharedPreferences()
+          .getBoolean(
+              String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey), true);
+    }
+    return firebaseApp.isDataCollectionDefaultEnabled();
   }
 
   /**
-   * Set whether firelog logging should be enabled. When not explicitly set, the default is true.
+   * Set whether firelog logging should be enabled. When not explicitly set, uses the Firebase wide
+   * data collection switch.
    *
    * @param enable - False to turn off logging. True to turn on logging.
    */
-  public synchronized void setCustomModelStatsCollectionEnabled(boolean enable) {
-    getSharedPreferences()
-        .edit()
-        .putBoolean(
-            String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey), enable)
-        .apply();
+  public synchronized void setCustomModelStatsCollectionEnabled(Boolean enable) {
+    if (enable == null) {
+      getSharedPreferences()
+          .edit()
+          .remove(String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey))
+          .commit();
+    } else {
+      getSharedPreferences()
+          .edit()
+          .putBoolean(
+              String.format(EVENT_LOGGING_ENABLED_PATTERN, CUSTOM_MODEL_LIB, persistenceKey),
+              enable)
+          .commit();
+    }
   }
 
   /**

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/FirebaseModelDownloaderTest.java

@@ -755,11 +755,14 @@ public void deleteDownloadedModel() throws Exception {
   @Test
   public void setStatsCollectionEnabled() {
     doNothing().when(mockPrefs).setCustomModelStatsCollectionEnabled(anyBoolean());
-    firebaseModelDownloader.setStatsCollectionEnabled(true);
+    firebaseModelDownloader.setModelDownloaderCollectionEnabled(true);
     verify(mockPrefs, times(1)).setCustomModelStatsCollectionEnabled(eq(true));
 
-    firebaseModelDownloader.setStatsCollectionEnabled(false);
+    firebaseModelDownloader.setModelDownloaderCollectionEnabled(false);
     verify(mockPrefs, times(1)).setCustomModelStatsCollectionEnabled(eq(false));
+
+    firebaseModelDownloader.setModelDownloaderCollectionEnabled(null);
+    verify(mockPrefs, times(1)).setCustomModelStatsCollectionEnabled(eq(null));
   }
 
   @Test

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/internal/SharedPreferencesUtilTest.java

@@ -46,19 +46,21 @@ public class SharedPreferencesUtilTest {
   private static final CustomModel CUSTOM_MODEL_DOWNLOADING =
       new CustomModel(MODEL_NAME, MODEL_HASH, 100, 986);
   private SharedPreferencesUtil sharedPreferencesUtil;
+  private FirebaseApp app;
 
   @Before
   public void setUp() {
     MockitoAnnotations.initMocks(this);
     FirebaseApp.clearInstancesForTest();
-    FirebaseApp app =
+    app =
         FirebaseApp.initializeApp(
             ApplicationProvider.getApplicationContext(),
             new FirebaseOptions.Builder()
                 .setApplicationId("1:123456789:android:abcdef")
                 .setProjectId(TEST_PROJECT_ID)
                 .build());
 
+    app.setDataCollectionDefaultEnabled(Boolean.TRUE);
     // default sharedPreferenceUtil
     sharedPreferencesUtil = new SharedPreferencesUtil(app);
     assertNotNull(sharedPreferencesUtil);
@@ -172,10 +174,33 @@ public void listDownloadedModels_multipleModels() {
   }
 
   @Test
-  public void getCustomModelStatsCollectionFlag_defaultTrue() {
+  public void getCustomModelStatsCollectionFlag_defaultFirebaseAppTrue() {
+    assertEquals(
+        sharedPreferencesUtil.getCustomModelStatsCollectionFlag(),
+        app.isDataCollectionDefaultEnabled());
     assertTrue(sharedPreferencesUtil.getCustomModelStatsCollectionFlag());
   }
 
+  @Test
+  public void getCustomModelStatsCollectionFlag_defaultFirebaseAppFalse() {
+    app.setDataCollectionDefaultEnabled(Boolean.FALSE);
+    // default sharedPreferenceUtil
+    SharedPreferencesUtil disableLogUtil = new SharedPreferencesUtil(app);
+    assertEquals(
+        disableLogUtil.getCustomModelStatsCollectionFlag(), app.isDataCollectionDefaultEnabled());
+    assertFalse(disableLogUtil.getCustomModelStatsCollectionFlag());
+  }
+
+  @Test
+  public void getCustomModelStatsCollectionFlag_overrideFirebaseAppFalse() {
+    app.setDataCollectionDefaultEnabled(Boolean.FALSE);
+    // default sharedPreferenceUtil
+    SharedPreferencesUtil sharedPreferencesUtil2 = new SharedPreferencesUtil(app);
+    sharedPreferencesUtil2.setCustomModelStatsCollectionEnabled(true);
+    assertEquals(sharedPreferencesUtil2.getCustomModelStatsCollectionFlag(), true);
+    assertTrue(sharedPreferencesUtil2.getCustomModelStatsCollectionFlag());
+  }
+
   @Test
   public void setCustomModelStatsCollectionFlag_updates() {
     sharedPreferencesUtil.setCustomModelStatsCollectionEnabled(false);
@@ -184,6 +209,19 @@ public void setCustomModelStatsCollectionFlag_updates() {
     assertTrue(sharedPreferencesUtil.getCustomModelStatsCollectionFlag());
   }
 
+  @Test
+  public void setCustomModelStatsCollectionFlag_nullUpdates() {
+    sharedPreferencesUtil.setCustomModelStatsCollectionEnabled(false);
+    sharedPreferencesUtil.setCustomModelStatsCollectionEnabled(null);
+    assertEquals(
+        sharedPreferencesUtil.getCustomModelStatsCollectionFlag(),
+        app.isDataCollectionDefaultEnabled());
+    app.setDataCollectionDefaultEnabled(Boolean.FALSE);
+    assertFalse(sharedPreferencesUtil.getCustomModelStatsCollectionFlag());
+    app.setDataCollectionDefaultEnabled(Boolean.TRUE);
+    assertTrue(sharedPreferencesUtil.getCustomModelStatsCollectionFlag());
+  }
+
   @Test
   public void getModelDownloadBeginTimeMs_default0() {
     assertEquals(sharedPreferencesUtil.getModelDownloadBeginTimeMs(CUSTOM_MODEL_DOWNLOADING), 0L);