Improve Kotlin API, add logs and tests

Author: tusharkhandelwal8

firebase-config/src/main/java/com/google/firebase/remoteconfig/RemoteConfig.kt

@@ -48,6 +48,9 @@ fun remoteConfigSettings(
   return builder.build()
 }
 
+fun customSignals(builder: CustomSignals.Builder.() -> Unit) =
+  CustomSignals.Builder().apply(builder).build()
+
 /**
  * Starts listening for config updates from the Remote Config backend and emits [ConfigUpdate]s via
  * a [Flow]. See [FirebaseRemoteConfig.addOnConfigUpdateListener] for more information.

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigFetchHttpClient.java

@@ -353,6 +353,9 @@ private JSONObject createFetchRequestBody(
 
     if (!customSignalsMap.isEmpty()) {
       requestBodyMap.put(CUSTOM_SIGNALS, new JSONObject(customSignalsMap));
+
+      // Log the custom signals during fetch.
+      Log.d(TAG, "Fetching with custom signals: " + customSignalsMap);
     }
 
     if (firstOpenTime != null) {

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigSharedPrefsClient.java

@@ -314,6 +314,9 @@ public void setCustomSignals(Map<String, String> newCustomSignals) {
           .edit()
           .putString(CUSTOM_SIGNALS, new JSONObject(existingCustomSignals).toString())
           .commit();
+
+      // Log the final updated custom signals.
+      Log.d(TAG, "Updated custom signals: " + getCustomSignals());
     }
   }
 

firebase-config/src/test/java/com/google/firebase/remoteconfig/CustomSignalsTest.java

@@ -0,0 +1,82 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.remoteconfig;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import com.google.common.collect.ImmutableMap;
+import java.util.HashMap;
+import java.util.Map;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+
+/** Unit tests for the {@link CustomSignals}.*/
+@RunWith(RobolectricTestRunner.class)
+@Config(manifest = Config.NONE)
+public class CustomSignalsTest {
+  @Test
+  public void testCustomSignals_builderPutString() {
+    CustomSignals customSignals =
+        new CustomSignals.Builder().put("key1", "value1").put("key2", "value2").build();
+    Map<String, String> expectedSignals = ImmutableMap.of("key1", "value1", "key2", "value2");
+    assertEquals(expectedSignals, customSignals.customSignals);
+  }
+
+  @Test
+  public void testCustomSignals_builderPutLong() {
+    CustomSignals customSignals =
+        new CustomSignals.Builder().put("key1", 123L).put("key2", 456L).build();
+    Map<String, String> expectedSignals = ImmutableMap.of("key1", "123", "key2", "456");
+    assertEquals(expectedSignals, customSignals.customSignals);
+  }
+
+  @Test
+  public void testCustomSignals_builderPutDouble() {
+    CustomSignals customSignals =
+        new CustomSignals.Builder().put("key1", 12.34).put("key2", 56.78).build();
+    Map<String, String> expectedSignals = ImmutableMap.of("key1", "12.34", "key2", "56.78");
+    assertEquals(expectedSignals, customSignals.customSignals);
+  }
+
+  @Test
+  public void testCustomSignals_builderPutMixedTypes() {
+    CustomSignals customSignals =
+        new CustomSignals.Builder()
+            .put("key1", "value1")
+            .put("key2", 123L)
+            .put("key3", 45.67)
+            .build();
+    Map<String, String> expectedSignals =
+        ImmutableMap.of("key1", "value1", "key2", "123", "key3", "45.67");
+    assertEquals(expectedSignals, customSignals.customSignals);
+  }
+
+  @Test
+  public void testCustomSignals_builderPutNullValue() {
+    CustomSignals customSignals = new CustomSignals.Builder().put("key1", null).build();
+    Map<String, String> expectedSignals = new HashMap<>();
+    expectedSignals.put("key1", null);
+    assertEquals(expectedSignals, customSignals.customSignals);
+  }
+
+  @Test
+  public void testCustomSignals_builderEmpty() {
+    CustomSignals customSignals = new CustomSignals.Builder().build();
+    assertTrue(customSignals.customSignals.isEmpty());
+  }
+}

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

@@ -1660,6 +1660,21 @@ public void realtimeRequest_setRequestParams_succeedsWithCorrectParams() throws
     assertThat(fakeConnection.getRequestMethod()).isEqualTo("POST");
   }
 
+  @Test
+  public void setCustomSignals_succeeds_and_calls_sharedPrefsClient() {
+    CustomSignals customSignals =
+        new CustomSignals.Builder()
+            .put("key1", "value1")
+            .put("key2", 123L)
+            .put("key3", 12.34)
+            .build();
+
+    Task<Void> setterTask = frc.setCustomSignals(customSignals);
+
+    assertThat(setterTask.isSuccessful()).isTrue();
+    verify(sharedPrefsClient).setCustomSignals(customSignals.customSignals);
+  }
+
   private static void loadCacheWithConfig(
       ConfigCacheClient cacheClient, ConfigContainer container) {
     when(cacheClient.getBlocking()).thenReturn(container);

firebase-config/src/test/java/com/google/firebase/remoteconfig/RemoteConfigTests.kt

@@ -17,6 +17,7 @@
 package com.google.firebase.remoteconfig
 
 import androidx.test.core.app.ApplicationProvider
+import com.google.common.collect.ImmutableMap
 import com.google.common.truth.Truth.assertThat
 import com.google.common.util.concurrent.MoreExecutors
 import com.google.firebase.Firebase
@@ -147,6 +148,60 @@ class ConfigTests : BaseTestCase() {
     `when`(mockGetHandler.getValue("KEY")).thenReturn(StringRemoteConfigValue("non default value"))
     assertThat(remoteConfig["KEY"].asString()).isEqualTo("non default value")
   }
+
+  @Test
+  fun `Custom Signals builder put string`() {
+    val customSignals = customSignals {
+      put("key1", "value1")
+      put("key2", "value2")
+    }
+    val expectedSignals = ImmutableMap.of("key1", "value1", "key2", "value2")
+    assertThat(customSignals.customSignals).isEqualTo(expectedSignals)
+  }
+
+  @Test
+  fun `Custom Signals builder put long`() {
+    val customSignals = customSignals {
+      put("key1", 123L)
+      put("key2", 456L)
+    }
+    val expectedSignals = ImmutableMap.of("key1", "123", "key2", "456")
+    assertThat(customSignals.customSignals).isEqualTo(expectedSignals)
+  }
+
+  @Test
+  fun `Custom Signals builder put double`() {
+    val customSignals = customSignals {
+      put("key1", 12.34)
+      put("key2", 56.78)
+    }
+    val expectedSignals = ImmutableMap.of("key1", "12.34", "key2", "56.78")
+    assertThat(customSignals.customSignals).isEqualTo(expectedSignals)
+  }
+
+  @Test
+  fun `Custom Signals builder put mixed types`() {
+    val customSignals = customSignals {
+      put("key1", "value1")
+      put("key2", 123L)
+      put("key3", 45.67)
+    }
+    val expectedSignals = ImmutableMap.of("key1", "value1", "key2", "123", "key3", "45.67")
+    assertThat(customSignals.customSignals).isEqualTo(expectedSignals)
+  }
+
+  @Test
+  fun `Custom Signals builder put null value`() {
+    val customSignals = customSignals { put("key1", null) }
+    val expectedSignals = mapOf("key1" to null)
+    assertThat(customSignals.customSignals).isEqualTo(expectedSignals)
+  }
+
+  @Test
+  fun `Custom Signals empty builder`() {
+    val customSignals = customSignals {}
+    assertThat(customSignals.customSignals).isEmpty()
+  }
 }
 
 @RunWith(RobolectricTestRunner::class)