Log warnings for invalid custom signals.

Author: tusharkhandelwal8

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

@@ -351,7 +351,13 @@ private JSONObject createFetchRequestBody(
 
     requestBodyMap.put(ANALYTICS_USER_PROPERTIES, new JSONObject(analyticsUserProperties));
 
-    requestBodyMap.put(CUSTOM_SIGNALS, new JSONObject(customSignalMap));
+    if (!customSignalMap.isEmpty()) {
+      Map<String, String> customSignalsStringMap = new HashMap<>();
+      for (Map.Entry<String, Object> entry : customSignalMap.entrySet()) {
+        customSignalsStringMap.put(entry.getKey(), String.valueOf(entry.getValue()));
+      }
+      requestBodyMap.put(CUSTOM_SIGNALS, new JSONObject(customSignalsStringMap));
+    }
 
     if (firstOpenTime != null) {
       requestBodyMap.put(FIRST_OPEN_TIME, convertToISOString(firstOpenTime));

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

@@ -18,12 +18,14 @@
 import static com.google.firebase.remoteconfig.FirebaseRemoteConfig.LAST_FETCH_STATUS_NO_FETCH_YET;
 import static com.google.firebase.remoteconfig.FirebaseRemoteConfig.LAST_FETCH_STATUS_SUCCESS;
 import static com.google.firebase.remoteconfig.FirebaseRemoteConfig.LAST_FETCH_STATUS_THROTTLED;
+import static com.google.firebase.remoteconfig.FirebaseRemoteConfig.TAG;
 import static com.google.firebase.remoteconfig.RemoteConfigComponent.CONNECTION_TIMEOUT_IN_SECONDS;
 import static com.google.firebase.remoteconfig.RemoteConfigConstants.RequestFieldKey.CUSTOM_SIGNALS;
 import static com.google.firebase.remoteconfig.internal.ConfigFetchHandler.DEFAULT_MINIMUM_FETCH_INTERVAL_IN_SECONDS;
 import static java.lang.annotation.RetentionPolicy.SOURCE;
 
 import android.content.SharedPreferences;
+import android.util.Log;
 import androidx.annotation.IntDef;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
@@ -81,6 +83,12 @@ public class ConfigMetadataClient {
   private static final String REALTIME_BACKOFF_END_TIME_IN_MILLIS_KEY =
       "realtime_backoff_end_time_in_millis";
 
+  /** Constants for custom signal limits. */
+  private static final int CUSTOM_SIGNALS_MAX_KEY_LENGTH = 250;
+
+  private static final int CUSTOM_SIGNALS_MAX_STRING_VALUE_LENGTH = 500;
+  private static final int CUSTOM_SIGNALS_MAX_COUNT = 100;
+
   private final SharedPreferences frcMetadata;
 
   private final Object frcInfoLock;
@@ -268,11 +276,18 @@ public void setCustomSignals(Map<String, Object> newCustomSignals) {
 
         // Validate value type, and key and value length
         if (value != null && !(value instanceof String || value instanceof Long)) {
-          throw new IllegalArgumentException("Custom signal values must be of type String or Long");
+          Log.w(TAG, "Invalid custom signal: Custom signal values must be of type String or Long.");
+          return;
         }
-        if (key.length() > 250 || (value instanceof String && ((String) value).length() > 500)) {
-          throw new IllegalArgumentException(
-              "Custom signal keys must be 250 characters or less, and string values must be 500 characters or less.");
+        if (key.length() > CUSTOM_SIGNALS_MAX_KEY_LENGTH
+            || (value instanceof String
+                && ((String) value).length() > CUSTOM_SIGNALS_MAX_STRING_VALUE_LENGTH)) {
+          Log.w(
+              TAG,
+              String.format(
+                  "Invalid custom signal: Custom signal keys must be %d characters or less, and string values must be %d characters or less.",
+                  CUSTOM_SIGNALS_MAX_KEY_LENGTH, CUSTOM_SIGNALS_MAX_STRING_VALUE_LENGTH));
+          return;
         }
 
         // Merge new signals with existing ones, overwriting existing keys.
@@ -288,9 +303,13 @@ public void setCustomSignals(Map<String, Object> newCustomSignals) {
       if (existingCustomSignals.equals(getCustomSignals())) {
         return;
       }
-      if (existingCustomSignals.size() > 100) {
-        throw new IllegalArgumentException(
-            "Too many custom signals provided. The maximum allowed is 100.");
+      if (existingCustomSignals.size() > CUSTOM_SIGNALS_MAX_COUNT) {
+        Log.w(
+            TAG,
+            String.format(
+                "Invalid custom signal: Too many custom signals provided. The maximum allowed is %d.",
+                CUSTOM_SIGNALS_MAX_COUNT));
+        return;
       }
 
       frcMetadata

firebase-config/src/test/java/com/google/firebase/remoteconfig/internal/ConfigMetadataClientTest.java

@@ -25,7 +25,7 @@
 import static com.google.firebase.remoteconfig.internal.ConfigMetadataClient.LAST_FETCH_TIME_NO_FETCH_YET;
 import static com.google.firebase.remoteconfig.internal.ConfigMetadataClient.NO_BACKOFF_TIME;
 import static com.google.firebase.remoteconfig.internal.ConfigMetadataClient.NO_FAILED_FETCHES;
-import static com.google.firebase.remoteconfig.testutil.Assert.assertThrows;
+import static com.google.firebase.remoteconfig.testutil.Assert.assertFalse;
 
 import android.content.Context;
 import android.content.SharedPreferences;
@@ -392,20 +392,17 @@ public void setCustomSignals_nullValue_removesSignal() {
   }
 
   @Test
-  public void setCustomSignals_invalidInput_throwsException() {
-    Map<String, Object> invalidSignals1 = new HashMap<>();
-    invalidSignals1.put("name", true);
-    assertThrows(
-        IllegalArgumentException.class, () -> metadataClient.setCustomSignals(invalidSignals1));
-
-    Map<String, Object> invalidSignals2 = new HashMap<>();
-    invalidSignals2.put("a".repeat(251), "value");
-    assertThrows(
-        IllegalArgumentException.class, () -> metadataClient.setCustomSignals(invalidSignals2));
-
-    Map<String, Object> invalidSignals3 = new HashMap<>();
-    invalidSignals3.put("key", "a".repeat(501));
-    assertThrows(
-        IllegalArgumentException.class, () -> metadataClient.setCustomSignals(invalidSignals3));
+  public void setCustomSignals_invalidInput_rejectsSignals() {
+    Map<String, Object> invalidSignals1 = ImmutableMap.of("name", true);
+    metadataClient.setCustomSignals(invalidSignals1);
+    assertFalse(metadataClient.getCustomSignals().containsKey("name"));
+
+    Map<String, Object> invalidSignals2 = ImmutableMap.of("a".repeat(251), "value");
+    metadataClient.setCustomSignals(invalidSignals2);
+    assertFalse(metadataClient.getCustomSignals().containsKey("a".repeat(251)));
+
+    Map<String, Object> invalidSignals3 = ImmutableMap.of("key", "a".repeat(501));
+    metadataClient.setCustomSignals(invalidSignals3);
+    assertFalse(metadataClient.getCustomSignals().containsKey("key"));
   }
 }