Postpone config rendering as string until reporting phase

Author: ygree

internal-api/src/main/java/datadog/trace/api/ConfigSetting.java

@@ -17,18 +17,31 @@ public final class ConfigSetting {
           Arrays.asList("DD_API_KEY", "dd.api-key", "dd.profiling.api-key", "dd.profiling.apikey"));
 
   public static ConfigSetting of(String key, Object value, ConfigOrigin origin) {
-    if (CONFIG_FILTER_LIST.contains(key)) {
-      value = "<hidden>";
+    return new ConfigSetting(key, value, origin);
+  }
+
+  private ConfigSetting(String key, Object value, ConfigOrigin origin) {
+    this.key = key;
+    this.value = CONFIG_FILTER_LIST.contains(key) ? "<hidden>" : value;
+    this.origin = origin;
+  }
+
+  public String normalizedKey() {
+    return key.toLowerCase().replace(".", "_");
+  }
+
+  public String stringValue() {
+    if (value == null) {
+      return null;
     } else if (value instanceof BitSet) {
-      value = renderIntegerRange((BitSet) value);
+      return renderIntegerRange((BitSet) value);
     } else if (value instanceof Map) {
-      value = renderMap((Map) value);
+      return renderMap((Map<Object, Object>) value);
     } else if (value instanceof Iterable) {
-      value = renderIterable((Iterable) value);
-    } else if (value != null) {
-      value = value.toString();
+      return renderIterable((Iterable) value);
+    } else {
+      return value.toString();
     }
-    return new ConfigSetting(key, value, origin);
   }
 
   private static String renderIntegerRange(BitSet bitset) {
@@ -81,16 +94,6 @@ private static String renderIterable(Iterable iterable) {
     return result.toString();
   }
 
-  private ConfigSetting(String key, Object value, ConfigOrigin origin) {
-    this.key = key;
-    this.value = value;
-    this.origin = origin;
-  }
-
-  public String normalizedKey() {
-    return key.toLowerCase().replace(".", "_");
-  }
-
   @Override
   public boolean equals(Object o) {
     if (this == o) return true;
@@ -108,10 +111,10 @@ public int hashCode() {
   public String toString() {
     return "ConfigSetting{"
         + "key='"
-        + key
+        + normalizedKey()
         + '\''
         + ", value="
-        + value
+        + stringValue()
         + ", origin="
         + origin
         + '}';

internal-api/src/test/groovy/datadog/trace/api/ConfigCollectorTest.groovy

@@ -24,7 +24,7 @@ class ConfigCollectorTest extends DDSpecification {
 
     expect:
     def setting = ConfigCollector.get().collect().get(configKey)
-    setting.value == configValue
+    setting.stringValue() == configValue
     setting.origin == ConfigOrigin.ENV
 
     where:
@@ -70,7 +70,7 @@ class ConfigCollectorTest extends DDSpecification {
 
     expect:
     def setting = ConfigCollector.get().collect().get(configKey)
-    setting.value == expectedValue
+    setting.stringValue() == expectedValue
     setting.origin == ConfigOrigin.JVM_PROP
 
     where:
@@ -87,7 +87,7 @@ class ConfigCollectorTest extends DDSpecification {
     expect:
     def setting = ConfigCollector.get().collect().get(configKey)
     setting.origin == ConfigOrigin.DEFAULT
-    setting.value == defaultValue
+    setting.stringValue() == defaultValue
 
     where:
     configKey                                                  | defaultValue
@@ -106,7 +106,7 @@ class ConfigCollectorTest extends DDSpecification {
 
     then:
     cs.key == configKey
-    cs.value == null
+    cs.stringValue() == null
     cs.origin == ConfigOrigin.DEFAULT
 
     where:
@@ -127,7 +127,7 @@ class ConfigCollectorTest extends DDSpecification {
 
     then:
     cs.key == configKey
-    cs.value == ""
+    cs.stringValue() == ""
     cs.origin == ConfigOrigin.DEFAULT
 
     where:
@@ -165,7 +165,7 @@ class ConfigCollectorTest extends DDSpecification {
     ConfigCollector.get().put('DD_API_KEY', 'sensitive data', ConfigOrigin.ENV)
 
     then:
-    ConfigCollector.get().collect().get('DD_API_KEY').value == '<hidden>'
+    ConfigCollector.get().collect().get('DD_API_KEY').stringValue() == '<hidden>'
   }
 
   def "collects common setting default values"() {
@@ -176,7 +176,7 @@ class ConfigCollectorTest extends DDSpecification {
     def setting = settings.get(key)
 
     setting.key == key
-    setting.value == value
+    setting.stringValue() == value
     setting.origin == ConfigOrigin.DEFAULT
 
     where:
@@ -209,7 +209,7 @@ class ConfigCollectorTest extends DDSpecification {
     def setting = settings.get(key)
 
     setting.key == key
-    setting.value == value
+    setting.stringValue() == value
     setting.origin == ConfigOrigin.ENV
 
     where:

internal-api/src/test/groovy/datadog/trace/api/ConfigSettingTest.groovy

@@ -32,7 +32,7 @@ class ConfigSettingTest extends Specification {
 
   def "filters key values"() {
     expect:
-    ConfigSetting.of(key, value, ConfigOrigin.DEFAULT).value == filteredValue
+    ConfigSetting.of(key, value, ConfigOrigin.DEFAULT).stringValue() == filteredValue
 
     where:
     key                    | value       | filteredValue
@@ -45,7 +45,7 @@ class ConfigSettingTest extends Specification {
 
   def "support basic types"() {
     expect:
-    ConfigSetting.of("key", value, ConfigOrigin.DEFAULT).value == rendered
+    ConfigSetting.of("key", value, ConfigOrigin.DEFAULT).stringValue() == rendered
 
     where:
     value          | rendered
@@ -60,7 +60,7 @@ class ConfigSettingTest extends Specification {
 
   def "convert Iterable, Map, and BitSet to String"() {
     expect:
-    ConfigSetting.of("key", value, ConfigOrigin.DEFAULT).value == rendered
+    ConfigSetting.of("key", value, ConfigOrigin.DEFAULT).stringValue() == rendered
 
     where:
     value                  | rendered

telemetry/src/main/java/datadog/telemetry/TelemetryRequestBody.java

@@ -218,9 +218,9 @@ public void writeConfiguration(ConfigSetting configSetting) throws IOException {
     bodyWriter.beginObject();
     bodyWriter.name("name").value(configSetting.normalizedKey());
     bodyWriter.setSerializeNulls(true);
-    bodyWriter.name("value").jsonValue(configSetting.value);
+    bodyWriter.name("value").value(configSetting.stringValue());
     bodyWriter.setSerializeNulls(false);
-    bodyWriter.name("origin").jsonValue(configSetting.origin.value);
+    bodyWriter.name("origin").value(configSetting.origin.value);
     bodyWriter.endObject();
   }
 

telemetry/src/test/groovy/datadog/telemetry/TelemetryRequestBodySpecification.groovy

@@ -70,8 +70,8 @@ class TelemetryRequestBodySpecification extends Specification {
     then:
     drainToString(req) == ',"configuration":[' +
       '{"name":"string","value":"bar","origin":"remote_config"},' +
-      '{"name":"int","value":2342,"origin":"default"},' +
-      '{"name":"double","value":123.456,"origin":"env_var"},' +
+      '{"name":"int","value":"2342","origin":"default"},' +
+      '{"name":"double","value":"123.456","origin":"env_var"},' +
       '{"name":"map","value":"key1:value1,key2:432.32,key3:324","origin":"jvm_prop"},' +
       '{"name":"list","value":"1,2,3","origin":"default"},' +
       '{"name":"null","value":null,"origin":"default"}]'

telemetry/src/test/groovy/datadog/telemetry/TestTelemetryRouter.groovy

@@ -235,7 +235,7 @@ class TestTelemetryRouter extends TelemetryRouter {
       def expected = configuration == null ? null : []
       if (configuration != null) {
         for (ConfigSetting cs : configuration) {
-          expected.add([name: cs.key, value: cs.value, origin: cs.origin.value])
+          expected.add([name: cs.normalizedKey(), value: cs.stringValue(), origin: cs.origin.value])
         }
       }
       assert this.payload['configuration'] == expected