Migrate from snakeyaml to snakeyaml-engine

ygree · ygree · commit 39a540b1183a · 2025-05-08T18:18:50.000-07:00
diff --git a/components/cli/build.gradle.kts b/components/cli/build.gradle.kts
@@ -1,9 +1 @@
-plugins {
-  id("me.champeau.jmh")
-}
-
 apply(from = "$rootDir/gradle/java.gradle")
-
-jmh {
-  version = "1.28"
-}
diff --git a/components/context/build.gradle.kts b/components/context/build.gradle.kts
@@ -1,13 +1,5 @@
-plugins {
-  id("me.champeau.jmh")
-}
-
 apply(from = "$rootDir/gradle/java.gradle")
 
-jmh {
-  version = "1.28"
-}
-
 val excludedClassesInstructionCoverage by extra {
   listOf("datadog.context.ContextProviders") // covered by forked test
 }
diff --git a/components/yaml/build.gradle.kts b/components/yaml/build.gradle.kts
@@ -4,11 +4,6 @@ plugins {
 
 apply(from = "$rootDir/gradle/java.gradle")
 
-jmh {
-  version = "1.28"
-}
-
-// 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,12 @@
 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);
-    }
+  public static Object parse(String content) {
+    LoadSettings settings = LoadSettings.builder().setAllowDuplicateKeys(true).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/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/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -52,7 +52,7 @@ final class CachedData {
       exclude(dependency('cafe.cryptography::'))
 
       // snakeyaml and its transitives
-      exclude(dependency('org.yaml:snakeyaml'))
+      exclude(dependency('org.snakeyaml:snakeyaml'))
     }
   ]
 }
diff --git a/internal-api/build.gradle b/internal-api/build.gradle
@@ -251,7 +251,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,6 +1,5 @@
 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;
@@ -10,8 +9,9 @@
 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,10 +41,11 @@ 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);
+      StableConfigYaml data = new StableConfigYaml(parsedYaml);
 
       String configId = data.getConfig_id();
-      ConfigurationMap configMap = data.getApm_configuration_default();
+      Map<String, Object> configMap = data.getApm_configuration_default();
       List<Rule> rules = data.getApm_configuration_rules();
 
       if (!rules.isEmpty()) {
@@ -53,14 +54,16 @@ public static StableConfigSource.StableConfig parse(String filePath) throws IOEx
           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, new LinkedHashMap<String, Object>(configMap));
       }
 
       // If there's a configId but no configMap, use configId but return an empty map
@@ -91,12 +94,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/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
@@ -1,38 +1,41 @@
 package datadog.trace.bootstrap.config.provider.stableconfigyaml;
 
 import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Collectors;
 
 // Rule represents a set of selectors and their corresponding configurations found in stable
 // configuration files
 public class Rule {
   private List<Selector> selectors;
-  private ConfigurationMap configuration;
+  private Map<String, Object> configuration;
 
   public Rule() {
     this.selectors = new ArrayList<>();
-    this.configuration = new ConfigurationMap();
+    this.configuration = new LinkedHashMap<>();
   }
 
-  public Rule(List<Selector> selectors, ConfigurationMap configuration) {
+  public Rule(List<Selector> selectors, Map<String, Object> configuration) {
     this.selectors = selectors;
     this.configuration = configuration;
   }
 
-  // Getters and setters
-  public List<Selector> getSelectors() {
-    return selectors;
+  public Rule(Object yaml) {
+    Map map = (Map) yaml;
+    selectors =
+        ((List<Object>) map.get("selectors"))
+            .stream().filter(Objects::nonNull).map(Selector::new).collect(Collectors.toList());
+    configuration = (Map<String, Object>) map.get("configuration");
   }
 
-  public void setSelectors(List<Selector> selectors) {
-    this.selectors = selectors;
+  public List<Selector> getSelectors() {
+    return selectors;
   }
 
-  public ConfigurationMap getConfiguration() {
+  public Map<String, Object> getConfiguration() {
     return configuration;
   }
-
-  public void setConfiguration(ConfigurationMap configuration) {
-    this.configuration = configuration;
-  }
 }
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
@@ -1,29 +1,29 @@
 package datadog.trace.bootstrap.config.provider.stableconfigyaml;
 
-import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 public class Selector {
   private String origin;
   private String key;
   private List<String> matches;
   private String operator;
 
-  public Selector() {
-    this.origin = null;
-    this.key = null;
-    this.matches = new ArrayList<>();
-    this.operator = null;
-  }
-
   public Selector(String origin, String key, List<String> matches, String operator) {
     this.origin = origin;
     this.key = key;
     this.matches = matches;
     this.operator = operator;
   }
 
-  // Getters and setters
+  public Selector(Object yaml) {
+    Map map = (Map) yaml;
+    origin = (String) map.get("origin");
+    key = (String) map.get("key");
+    matches = (List<String>) map.get("matches");
+    operator = (String) map.get("operator");
+  }
+
   public String getOrigin() {
     return origin;
   }
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
@@ -1,20 +1,32 @@
 package datadog.trace.bootstrap.config.provider.stableconfigyaml;
 
 import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 
 public class StableConfigYaml {
   private String config_id; // optional
-  private ConfigurationMap apm_configuration_default;
+  private Map<String, Object> apm_configuration_default;
   private List<Rule> apm_configuration_rules; // optional
 
+  public StableConfigYaml(Object yaml) {
+    Map<Object, Object> map = (Map<Object, Object>) yaml;
+    this.config_id = String.valueOf(map.get("config_id"));
+    this.apm_configuration_default =
+        (Map<String, Object>) map.getOrDefault("apm_configuration_default", new LinkedHashMap<>());
+    this.apm_configuration_rules =
+        ((List<Object>) map.getOrDefault("apm_configuration_rules", new ArrayList<>()))
+            .stream().map(Rule::new).collect(Collectors.toList());
+  }
+
   public StableConfigYaml() {
     this.config_id = null;
-    this.apm_configuration_default = new ConfigurationMap();
+    this.apm_configuration_default = new LinkedHashMap<>();
     this.apm_configuration_rules = new ArrayList<>();
   }
 
-  // Getters and setters
   public String getConfig_id() {
     return config_id;
   }
@@ -23,19 +35,15 @@ public void setConfig_id(String config_id) {
     this.config_id = config_id;
   }
 
-  public ConfigurationMap getApm_configuration_default() {
+  public Map<String, Object> getApm_configuration_default() {
     return apm_configuration_default;
   }
 
-  public void setApm_configuration_default(ConfigurationMap apm_configuration_default) {
+  public void setApm_configuration_default(Map<String, Object> apm_configuration_default) {
     this.apm_configuration_default = apm_configuration_default;
   }
 
   public List<Rule> getApm_configuration_rules() {
     return apm_configuration_rules;
   }
-
-  public void setApm_configuration_rules(List<Rule> apm_configuration_rules) {
-    this.apm_configuration_rules = apm_configuration_rules;
-  }
 }
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
`@@ -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
`@@ -52,7 +52,7 @@ final class CachedData {`
`52`	`52`	`exclude(dependency('cafe.cryptography::'))`
`53`	`53`
`54`	`54`	`// snakeyaml and its transitives`
`55`		`- exclude(dependency('org.yaml:snakeyaml'))`
	`55`	`+ exclude(dependency('org.snakeyaml:snakeyaml'))`
`56`	`56`	`}`
`57`	`57`	`]`
`58`	`58`	`}`