Support targeting services with configurations in stable configuration file (#8526)

Co-authored-by: Stuart McCulloch <[email protected]>

Author: mtoffl01

components/yaml/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+  id("me.champeau.jmh")
+}
+
+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")
+}

components/yaml/src/main/java/datadog/yaml/YamlParser.java

@@ -0,0 +1,19 @@
+package datadog.yaml;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import org.yaml.snakeyaml.Yaml;
+
+public class YamlParser {
+  // Supports clazz == null for default yaml parsing
+  public static <T> T parse(String filePath, Class<T> clazz) throws IOException {
+    Yaml yaml = new Yaml();
+    try (FileInputStream fis = new FileInputStream(filePath)) {
+      if (clazz == null) {
+        return yaml.load(fis);
+      } else {
+        return yaml.loadAs(fis, clazz);
+      }
+    }
+  }
+}

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/Constants.java

@@ -16,6 +16,7 @@ public final class Constants {
   public static final String[] BOOTSTRAP_PACKAGE_PREFIXES = {
     "datadog.slf4j",
     "datadog.json",
+    "datadog.yaml",
     "datadog.context",
     "datadog.cli",
     "datadog.appsec.api",

dd-java-agent/build.gradle

@@ -59,8 +59,9 @@ ext.generalShadowJarConfig = {
 
   final String projectName = "${project.name}"
 
-  // Prevents conflict with other OkHttp instances, but don't relocate instrumentation
+  // Prevents conflict with other instances, but doesn't relocate instrumentation
   if (!projectName.equals('instrumentation')) {
+    relocate 'org.yaml.snakeyaml', 'datadog.snakeyaml'
     relocate 'okhttp3', 'datadog.okhttp3'
     relocate 'okio',  'datadog.okio'
   }

dd-java-agent/instrumentation/build.gradle

@@ -59,6 +59,9 @@ subprojects { Project subProj ->
       def name = "java$version.majorVersion"
       jdkCompile = "main_${name}Implementation"
     }
+    configurations.muzzleBootstrap {
+      exclude group: 'org.yaml', module : 'snakeyaml' // we vendor this in the agent jar
+    }
     dependencies {
       // Apply common dependencies for instrumentation.
       implementation project(':dd-trace-api')

dd-java-agent/instrumentation/snakeyaml/build.gradle

@@ -18,7 +18,13 @@ addTestSuiteForDir('latestDepTest', 'test')
 
 dependencies {
   compileOnly group: 'org.yaml', name: 'snakeyaml', version: '1.33'
-  testImplementation group: 'org.yaml', name: 'snakeyaml', version: '1.33'
+
+  testImplementation('org.yaml:snakeyaml') {
+    version {
+      strictly "[1.4, 2.0)"
+      prefer '1.33'
+    }
+  }
 
   latestDepTestImplementation group: 'org.yaml', name: 'snakeyaml', version: '1.+'
 }

dd-java-agent/testing/build.gradle

@@ -38,6 +38,10 @@ excludedClassesCoverage += [
   'datadog.trace.agent.test.TestProfilingContextIntegration.TestQueueTiming'
 ]
 
+configurations.api {
+  exclude group: 'org.yaml', module: 'snakeyaml' // we vendor this in the agent jar
+}
+
 dependencies {
   api libs.bytebuddy
   api libs.bytebuddyagent

dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/SpockRunner.java

@@ -39,6 +39,7 @@ public class SpockRunner extends JUnitPlatform {
   public static final String[] BOOTSTRAP_PACKAGE_PREFIXES_COPY = {
     "datadog.slf4j",
     "datadog.json",
+    "datadog.yaml",
     "datadog.context",
     "datadog.cli",
     "datadog.appsec.api",

gradle/dependencies.gradle

@@ -18,6 +18,7 @@ final class CachedData {
       exclude(project(':communication'))
       exclude(project(':components:context'))
       exclude(project(':components:json'))
+      exclude(project(':components:yaml'))
       exclude(project(':components:cli'))
       exclude(project(':remote-config:remote-config-api'))
       exclude(project(':remote-config:remote-config-core'))
@@ -49,6 +50,9 @@ final class CachedData {
 
       // cafe_crypto and its transitives
       exclude(dependency('cafe.cryptography::'))
+
+      // snakeyaml and its transitives
+      exclude(dependency('org.yaml:snakeyaml'))
     }
   ]
 }

internal-api/build.gradle

@@ -239,21 +239,22 @@ dependencies {
   api project(':dd-trace-api')
   api libs.slf4j
   api project(':components:context')
+  api project(':components:yaml')
   api project(':components:cli')
   api project(":utils:time-utils")
 
   // has to be loaded by system classloader:
   // 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 project(":utils:test-utils")
   testImplementation("org.assertj:assertj-core:3.20.2")
   testImplementation libs.bundles.junit5
   testImplementation group: 'org.junit.vintage', name: 'junit-vintage-engine', version: libs.versions.junit5.get()
   testImplementation libs.commons.math
   testImplementation libs.bundles.mockito
   testImplementation libs.truth
-  testImplementation 'org.yaml:snakeyaml:2.0'
 }
 
 jmh {