Migration of the stable config from snakeyaml to snakeyaml-engine (#8790)

ygree · web-flow · commit c7b5ca4cfb4e · 2025-05-22T14:55:13.000+02:00
diff --git a/components/yaml/build.gradle.kts b/components/yaml/build.gradle.kts
@@ -4,7 +4,6 @@ plugins {
 
 apply(from = "$rootDir/gradle/java.gradle")
 
-// https://repo1.maven.org/maven2/org/yaml/snakeyaml/2.4/snakeyaml-2.4.pom
 dependencies {
-  implementation("org.yaml", "snakeyaml", "2.4")
+  implementation("org.snakeyaml", "snakeyaml-engine", "2.9")
 }
diff --git a/components/yaml/src/main/java/datadog/yaml/YamlParser.java b/components/yaml/src/main/java/datadog/yaml/YamlParser.java
@@ -1,15 +1,18 @@
 package datadog.yaml;
 
-import org.yaml.snakeyaml.Yaml;
+import org.snakeyaml.engine.v2.api.Load;
+import org.snakeyaml.engine.v2.api.LoadSettings;
 
 public class YamlParser {
-  // Supports clazz == null for default yaml parsing
-  public static <T> T parse(String content, Class<T> clazz) {
-    Yaml yaml = new Yaml();
-    if (clazz == null) {
-      return yaml.load(content);
-    } else {
-      return yaml.loadAs(content, clazz);
-    }
+  /**
+   * Parses YAML content. Duplicate keys are not allowed and will result in a runtime exception..
+   *
+   * @param content - text context to be parsed as YAML
+   * @return - a parsed representation as a composition of map and list objects.
+   */
+  public static Object parse(String content) {
+    LoadSettings settings = LoadSettings.builder().build();
+    Load yaml = new Load(settings);
+    return yaml.loadFromString(content);
   }
 }
diff --git a/dd-java-agent/build.gradle b/dd-java-agent/build.gradle
@@ -38,7 +38,7 @@ ext.generalShadowJarConfig = {
   // used to report our own dependencies, but we should remove the top-level metadata
   // of vendored packages because those could trigger unwanted framework checks.
   exclude '/META-INF/maven/org.slf4j/**'
-  exclude '/META-INF/maven/org.yaml/**'
+  exclude '/META-INF/maven/org.snakeyaml/**'
   exclude '**/META-INF/maven/**/pom.xml'
   exclude '**/META-INF/proguard/'
   exclude '**/META-INF/*.kotlin_module'
@@ -66,7 +66,7 @@ ext.generalShadowJarConfig = {
 
   // Prevents conflict with other instances, but doesn't relocate instrumentation
   if (!projectName.equals('instrumentation')) {
-    relocate 'org.yaml.snakeyaml', 'datadog.snakeyaml'
+    relocate 'org.snakeyaml.engine', 'datadog.snakeyaml.engine'
     relocate 'okhttp3', 'datadog.okhttp3'
     relocate 'okio',  'datadog.okio'
   }
diff --git a/dd-java-agent/instrumentation/build.gradle b/dd-java-agent/instrumentation/build.gradle
@@ -60,7 +60,7 @@ subprojects { Project subProj ->
       jdkCompile = "main_${name}Implementation"
     }
     configurations.muzzleBootstrap {
-      exclude group: 'org.yaml', module : 'snakeyaml' // we vendor this in the agent jar
+      exclude group: 'org.snakeyaml', module : 'snakeyaml-engine' // we vendor this in the agent jar
     }
     dependencies {
       // Apply common dependencies for instrumentation.
diff --git a/dd-java-agent/instrumentation/graal/native-image/src/main/java/datadog/trace/instrumentation/graal/nativeimage/ResourcesFeatureInstrumentation.java b/dd-java-agent/instrumentation/graal/native-image/src/main/java/datadog/trace/instrumentation/graal/nativeimage/ResourcesFeatureInstrumentation.java
@@ -50,8 +50,7 @@ public static void onExit() {
       tracerResources.add("profiling/jfr/overrides/minimal.jfp");
 
       // jmxfetch configs
-      tracerResources.add(
-          "metrics/project.properties"); // org.datadog.jmxfetch.AppConfig reads its version
+      tracerResources.add("metrics/project.properties");
       tracerResources.add("metrics/org/datadog/jmxfetch/default-jmx-metrics.yaml");
       tracerResources.add("metrics/org/datadog/jmxfetch/new-gc-default-jmx-metrics.yaml");
       tracerResources.add("metrics/org/datadog/jmxfetch/old-gc-default-jmx-metrics.yaml");
diff --git a/dd-java-agent/testing/build.gradle b/dd-java-agent/testing/build.gradle
@@ -39,7 +39,7 @@ excludedClassesCoverage += [
 ]
 
 configurations.api {
-  exclude group: 'org.yaml', module: 'snakeyaml' // we vendor this in the agent jar
+  exclude group: 'org.snakeyaml', module: 'snakeyaml-engine' // we vendor this in the agent jar
 }
 
 dependencies {
diff --git a/dd-smoke-tests/spring-boot-3.0-native/application/build.gradle b/dd-smoke-tests/spring-boot-3.0-native/application/build.gradle
@@ -39,7 +39,6 @@ if (hasProperty('agentPath')) {
         if (withProfiler && property('profiler') == 'true') {
           buildArgs.add("-J-Ddd.profiling.enabled=true")
         }
-        buildArgs.add("--enable-monitoring=jmxserver")
         jvmArgs.add("-Xmx3072M")
       }
     }
diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -51,8 +51,8 @@ final class CachedData {
       // cafe_crypto and its transitives
       exclude(dependency('cafe.cryptography::'))
 
-      // snakeyaml and its transitives
-      exclude(dependency('org.yaml:snakeyaml'))
+      // snakeyaml-engine and its transitives
+      exclude(dependency('org.snakeyaml:snakeyaml-engine'))
     }
   ]
 }
diff --git a/internal-api/build.gradle b/internal-api/build.gradle
@@ -252,7 +252,7 @@ dependencies {
   // it contains annotations that are also present in the instrumented application classes
   api "com.datadoghq:dd-javac-plugin-client:0.2.2"
 
-  testImplementation("org.yaml:snakeyaml:2.4")
+  testImplementation("org.snakeyaml:snakeyaml-engine:2.9")
   testImplementation project(":utils:test-utils")
   testImplementation("org.assertj:assertj-core:3.20.2")
   testImplementation libs.bundles.junit5
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/StableConfigParser.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/StableConfigParser.java
@@ -1,17 +1,17 @@
 package datadog.trace.bootstrap.config.provider;
 
-import datadog.trace.bootstrap.config.provider.stableconfigyaml.ConfigurationMap;
-import datadog.trace.bootstrap.config.provider.stableconfigyaml.Rule;
-import datadog.trace.bootstrap.config.provider.stableconfigyaml.Selector;
-import datadog.trace.bootstrap.config.provider.stableconfigyaml.StableConfigYaml;
+import datadog.trace.bootstrap.config.provider.stableconfig.Rule;
+import datadog.trace.bootstrap.config.provider.stableconfig.Selector;
+import datadog.trace.bootstrap.config.provider.stableconfig.StableConfig;
 import datadog.yaml.YamlParser;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.Collections;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.function.BiPredicate;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -41,26 +41,28 @@ public static StableConfigSource.StableConfig parse(String filePath) throws IOEx
     try {
       String content = new String(Files.readAllBytes(Paths.get(filePath)), StandardCharsets.UTF_8);
       String processedContent = processTemplate(content);
-      StableConfigYaml data = YamlParser.parse(processedContent, StableConfigYaml.class);
+      Object parsedYaml = YamlParser.parse(processedContent);
+      StableConfig data = new StableConfig(parsedYaml);
 
-      String configId = data.getConfig_id();
-      ConfigurationMap configMap = data.getApm_configuration_default();
-      List<Rule> rules = data.getApm_configuration_rules();
+      String configId = data.getConfigId();
+      Map<String, Object> configMap = data.getApmConfigurationDefault();
+      List<Rule> rules = data.getApmConfigurationRules();
 
       if (!rules.isEmpty()) {
         for (Rule rule : rules) {
           // Use the first matching rule
           if (doesRuleMatch(rule)) {
             // Merge configs found in apm_configuration_rules with those found in
             // apm_configuration_default
-            configMap.putAll(rule.getConfiguration());
-            return createStableConfig(configId, configMap);
+            Map<String, Object> mergedConfigMap = new LinkedHashMap<>(configMap);
+            mergedConfigMap.putAll(rule.getConfiguration());
+            return new StableConfigSource.StableConfig(configId, mergedConfigMap);
           }
         }
       }
       // If configs were found in apm_configuration_default, use them
       if (!configMap.isEmpty()) {
-        return createStableConfig(configId, configMap);
+        return new StableConfigSource.StableConfig(configId, configMap);
       }
 
       // If there's a configId but no configMap, use configId but return an empty map
@@ -69,10 +71,7 @@ public static StableConfigSource.StableConfig parse(String filePath) throws IOEx
       }
 
     } catch (IOException e) {
-      log.debug(
-          "Stable configuration file either not found or not readable at filepath {}. Error: {}",
-          filePath,
-          e.getMessage());
+      log.debug("Failed to read the stable configuration file: {}", filePath, e);
     }
     return StableConfigSource.StableConfig.EMPTY;
   }
@@ -91,12 +90,6 @@ private static boolean doesRuleMatch(Rule rule) {
     return true; // Return true if all selectors match
   }
 
-  /** Creates a StableConfig object from the provided configId and configMap. */
-  private static StableConfigSource.StableConfig createStableConfig(
-      String configId, ConfigurationMap configMap) {
-    return new StableConfigSource.StableConfig(configId, new HashMap<>(configMap));
-  }
-
   private static boolean validOperatorForLanguageOrigin(String operator) {
     operator = operator.toLowerCase();
     // "exists" is not valid
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/Rule.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/Rule.java
@@ -0,0 +1,44 @@
+package datadog.trace.bootstrap.config.provider.stableconfig;
+
+import static java.util.Collections.*;
+import static java.util.stream.Collectors.toList;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Rule represents a set of selectors and their corresponding configurations found in stable
+ * configuration files
+ */
+public final class Rule {
+  private final List<Selector> selectors;
+  private final Map<String, Object> configuration;
+
+  public Rule() {
+    this.selectors = emptyList();
+    this.configuration = emptyMap();
+  }
+
+  public Rule(List<Selector> selectors, Map<String, Object> configuration) {
+    this.selectors = selectors;
+    this.configuration = configuration;
+  }
+
+  public Rule(Object yaml) {
+    Map map = (Map) yaml;
+    selectors =
+        unmodifiableList(
+            ((List<Object>) map.get("selectors"))
+                .stream().filter(Objects::nonNull).map(Selector::new).collect(toList()));
+    configuration = unmodifiableMap((Map<String, Object>) map.get("configuration"));
+  }
+
+  public List<Selector> getSelectors() {
+    return selectors;
+  }
+
+  public Map<String, Object> getConfiguration() {
+    return configuration;
+  }
+}
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/Selector.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/Selector.java
@@ -0,0 +1,43 @@
+package datadog.trace.bootstrap.config.provider.stableconfig;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+public final class Selector {
+  private final String origin;
+  private final String key;
+  private final List<String> matches;
+  private final String operator;
+
+  public Selector(String origin, String key, List<String> matches, String operator) {
+    this.origin = origin;
+    this.key = key;
+    this.matches = matches;
+    this.operator = operator;
+  }
+
+  public Selector(Object yaml) {
+    Map map = (Map) yaml;
+    origin = (String) map.get("origin");
+    key = (String) map.get("key");
+    matches = Collections.unmodifiableList((List<String>) map.get("matches"));
+    operator = (String) map.get("operator");
+  }
+
+  public String getOrigin() {
+    return origin;
+  }
+
+  public String getKey() {
+    return key;
+  }
+
+  public List<String> getMatches() {
+    return matches;
+  }
+
+  public String getOperator() {
+    return operator;
+  }
+}
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/StableConfig.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfig/StableConfig.java
@@ -0,0 +1,48 @@
+package datadog.trace.bootstrap.config.provider.stableconfig;
+
+import static java.util.Collections.emptyList;
+import static java.util.Collections.emptyMap;
+import static java.util.Collections.unmodifiableList;
+import static java.util.Collections.unmodifiableMap;
+import static java.util.stream.Collectors.toList;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public final class StableConfig {
+  private final String configId;
+  private final Map<String, Object> apmConfigurationDefault;
+  private final List<Rule> apmConfigurationRules;
+
+  public StableConfig(Object yaml) {
+    Map<Object, Object> map = (Map<Object, Object>) yaml;
+    this.configId = String.valueOf(map.get("config_id"));
+    this.apmConfigurationDefault =
+        unmodifiableMap(
+            (Map<String, Object>) map.getOrDefault("apm_configuration_default", emptyMap()));
+    this.apmConfigurationRules =
+        unmodifiableList(
+            ((List<Object>) map.getOrDefault("apm_configuration_rules", emptyList()))
+                .stream().map(Rule::new).collect(toList()));
+  }
+
+  // test only
+  private StableConfig(String configId, Map<String, Object> apmConfigurationDefault) {
+    this.configId = configId;
+    this.apmConfigurationDefault = apmConfigurationDefault;
+    this.apmConfigurationRules = new ArrayList<>();
+  }
+
+  public String getConfigId() {
+    return configId;
+  }
+
+  public Map<String, Object> getApmConfigurationDefault() {
+    return apmConfigurationDefault;
+  }
+
+  public List<Rule> getApmConfigurationRules() {
+    return apmConfigurationRules;
+  }
+}
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/ConfigurationMap.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/ConfigurationMap.java
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/Rule.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/Rule.java
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/Selector.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/Selector.java
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/StableConfigYaml.java b/internal-api/src/main/java/datadog/trace/bootstrap/config/provider/stableconfigyaml/StableConfigYaml.java
diff --git a/internal-api/src/test/groovy/datadog/trace/bootstrap/config/provider/StableConfigParserTest.groovy b/internal-api/src/test/groovy/datadog/trace/bootstrap/config/provider/StableConfigParserTest.groovy
diff --git a/internal-api/src/test/groovy/datadog/trace/bootstrap/config/provider/StableConfigSourceTest.groovy b/internal-api/src/test/groovy/datadog/trace/bootstrap/config/provider/StableConfigSourceTest.groovy

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ plugins {`
`4`	`4`
`5`	`5`	`apply(from = "$rootDir/gradle/java.gradle")`
`6`	`6`
`7`		`-// https://repo1.maven.org/maven2/org/yaml/snakeyaml/2.4/snakeyaml-2.4.pom`
`8`	`7`	`dependencies {`
`9`		`- implementation("org.yaml", "snakeyaml", "2.4")`
	`8`	`+ implementation("org.snakeyaml", "snakeyaml-engine", "2.9")`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ subprojects { Project subProj ->`
`60`	`60`	`jdkCompile = "main_${name}Implementation"`
`61`	`61`	`}`
`62`	`62`	`configurations.muzzleBootstrap {`
`63`		`- exclude group: 'org.yaml', module : 'snakeyaml' // we vendor this in the agent jar`
	`63`	`+ exclude group: 'org.snakeyaml', module : 'snakeyaml-engine' // we vendor this in the agent jar`
`64`	`64`	`}`
`65`	`65`	`dependencies {`
`66`	`66`	`// Apply common dependencies for instrumentation.`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ excludedClassesCoverage += [`
`39`	`39`	`]`
`40`	`40`
`41`	`41`	`configurations.api {`
`42`		`- exclude group: 'org.yaml', module: 'snakeyaml' // we vendor this in the agent jar`
	`42`	`+ exclude group: 'org.snakeyaml', module: 'snakeyaml-engine' // we vendor this in the agent jar`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ if (hasProperty('agentPath')) {`
`39`	`39`	`if (withProfiler && property('profiler') == 'true') {`
`40`	`40`	`buildArgs.add("-J-Ddd.profiling.enabled=true")`
`41`	`41`	`}`
`42`		`- buildArgs.add("--enable-monitoring=jmxserver")`
`43`	`42`	`jvmArgs.add("-Xmx3072M")`
`44`	`43`	`}`
`45`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,8 @@ final class CachedData {`
`51`	`51`	`// cafe_crypto and its transitives`
`52`	`52`	`exclude(dependency('cafe.cryptography::'))`
`53`	`53`
`54`		`- // snakeyaml and its transitives`
`55`		`- exclude(dependency('org.yaml:snakeyaml'))`
	`54`	`+ // snakeyaml-engine and its transitives`
	`55`	`+ exclude(dependency('org.snakeyaml:snakeyaml-engine'))`
`56`	`56`	`}`
`57`	`57`	`]`
`58`	`58`	`}`