Deprecate crashlytics param to KeyValueBuilder

Author: mrober

firebase-crashlytics/src/androidTest/java/com/google/firebase/crashlytics/CrashlyticsTests.kt

@@ -68,10 +68,23 @@ class CrashlyticsTests {
 
     val result: Map<String, String> = keyValueBuilder.build().keysAndValues
 
-    // TODO(mrober): Make unit tests for this.
+    // The result is not empty because we need to pass the CustomKeysAndValues around.
     assertThat(result).isNotEmpty()
   }
 
+  @Test
+  fun keyValueBuilder_withCrashlyticsInstance() {
+    val keyValueBuilder = KeyValueBuilder(Firebase.crashlytics)
+    keyValueBuilder.key("hello", "world")
+    keyValueBuilder.key("hello2", 23)
+    keyValueBuilder.key("hello3", 0.1)
+
+    val result: Map<String, String> = keyValueBuilder.build().keysAndValues
+
+    // The result is empty because it called crashlytics.setCustomKey for every key.
+    assertThat(result).isEmpty()
+  }
+
   companion object {
     private const val APP_ID = "1:1:android:1a"
     private const val API_KEY = "API-KEY-API-KEY-API-KEY-API-KEY-API-KEY"

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/KeyValueBuilder.kt

@@ -17,38 +17,43 @@
 package com.google.firebase.crashlytics
 
 /** Helper class to enable fluent syntax in [setCustomKeys] */
-class KeyValueBuilder internal constructor() {
+@Suppress("DEPRECATION")
+class KeyValueBuilder(
+  // TODO(mrober): Remove this param and make ctor internal in 2025.
+  @Deprecated(message = "The crashlytics instance is no longer needed and will be removed in 2025.")
+  private val crashlytics: FirebaseCrashlytics? = null
+) {
   private val builder = CustomKeysAndValues.Builder()
 
   internal fun build(): CustomKeysAndValues = builder.build()
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: Boolean) {
-    builder.putBoolean(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putBoolean(key, value)
   }
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: Double) {
-    builder.putDouble(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putDouble(key, value)
   }
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: Float) {
-    builder.putFloat(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putFloat(key, value)
   }
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: Int) {
-    builder.putInt(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putInt(key, value)
   }
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: Long) {
-    builder.putLong(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putLong(key, value)
   }
 
   /** Sets a custom key and value that are associated with reports. */
   fun key(key: String, value: String) {
-    builder.putString(key, value)
+    crashlytics?.setCustomKey(key, value) ?: builder.putString(key, value)
   }
 }

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/common/CrashlyticsCore.java

@@ -368,7 +368,9 @@ public void setCustomKey(String key, String value) {
    * @throws NullPointerException if any key in keysAndValues is null.
    */
   public void setCustomKeys(Map<String, String> keysAndValues) {
-    crashlyticsWorkers.common.submit(() -> controller.setCustomKeys(keysAndValues));
+    if (!keysAndValues.isEmpty()) {
+      crashlyticsWorkers.common.submit(() -> controller.setCustomKeys(keysAndValues));
+    }
   }
 
   // endregion