fix: Proper shadowing of jetty in agent-testing

Author: bric3

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

@@ -11,22 +11,6 @@ dependencies {
   testImplementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.2.3'
   testImplementation group: 'com.fasterxml.jackson.module', name: 'jackson-module-afterburner', version: '2.9.10'
 
-  constraints {
-    // Don't want to conflict with jetty from the test server.
-    testImplementation('org.eclipse.jetty:jetty-server') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.2.9.v20150224'
-      }
-    }
-    testImplementation('org.eclipse.jetty:jetty-servlet') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.2.9.v20150224'
-      }
-    }
-  }
-
   // Anything 1.0+ fails with a java.lang.NoClassDefFoundError: org/eclipse/jetty/server/RequestLog
   //  latestDepTestImplementation group: 'io.dropwizard', name: 'dropwizard-testing', version: '1.+'
 }

dd-java-agent/instrumentation/jetty/jetty-client/jetty-client-9.1/build.gradle

@@ -54,20 +54,6 @@ dependencies {
   testImplementation project(':dd-java-agent:instrumentation:jetty:jetty-util-9.4.31')
   testImplementation group: 'org.eclipse.jetty', name: 'jetty-client', version: '9.1.0.v20131115'
   testImplementation group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.1.0.v20131115'
-  constraints {
-    testImplementation('org.eclipse.jetty:jetty-server') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.1.0.v20131115'
-      }
-    }
-    testImplementation('org.eclipse.jetty:jetty-servlet') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.1.0.v20131115'
-      }
-    }
-  }
 
   latestDepTestImplementation group: 'org.eclipse.jetty', name: 'jetty-client', version: '9.+'
   latestDepTestImplementation group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.+'

dd-java-agent/instrumentation/jetty/jetty-server/jetty-server-9.0.4/build.gradle

@@ -26,22 +26,6 @@ dependencies {
   testImplementation testFixtures(project(":dd-java-agent:instrumentation:jetty:jetty-server:jetty-server-9.0"))
   testImplementation testFixtures(project(':dd-java-agent:instrumentation:servlet:javax-servlet:javax-servlet-3.0'))
 
-  constraints {
-    // Don't want to conflict with jetty from the test server.
-    testImplementation('org.eclipse.jetty:jetty-server') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.0.4.v20130625'
-      }
-    }
-    testImplementation('org.eclipse.jetty:jetty-servlet') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '9.0.4.v20130625'
-      }
-    }
-  }
-
   // Include all jetty-server instrumentation modules for testing. Only the version-compatible module will apply at runtime.
   testRuntimeOnly project(":dd-java-agent:instrumentation:jetty:jetty-server:jetty-server-9.0")
   testRuntimeOnly project(':dd-java-agent:instrumentation:servlet:javax-servlet:javax-servlet-2.2')

dd-java-agent/instrumentation/jetty/jetty-server/jetty-server-9.0/build.gradle

@@ -43,21 +43,6 @@ dependencies {
   testImplementation testFixtures(project(':dd-java-agent:instrumentation:servlet:javax-servlet:javax-servlet-3.0'))
   testFixturesImplementation testFixtures(project(':dd-java-agent:instrumentation:servlet:javax-servlet:javax-servlet-3.0'))
   testImplementation project(':dd-java-agent:appsec:appsec-test-fixtures')
-  constraints {
-    // Don't want to conflict with jetty from the test server.
-    testImplementation('org.eclipse.jetty:jetty-server') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly jetty9Version
-      }
-    }
-    testImplementation('org.eclipse.jetty:jetty-servlet') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly jetty9Version
-      }
-    }
-  }
 
   testFixturesCompileOnly(libs.bundles.groovy)
 }

dd-java-agent/instrumentation/servlet/javax-servlet/javax-servlet-3.0/build.gradle

@@ -62,21 +62,6 @@ dependencies {
   testImplementation group: 'org.apache.tomcat.embed', name: 'tomcat-embed-core', version: '8.0.41'
   testImplementation group: 'org.apache.tomcat.embed', name: 'tomcat-embed-jasper', version: '8.0.41'
 
-  constraints {
-    testImplementation('org.eclipse.jetty:jetty-server') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '8.2.0.v20160908'
-      }
-    }
-    testImplementation('org.eclipse.jetty:jetty-servlet') {
-      because(":dd-java-agent:testing comes with a newer version that may cause conflicts")
-      version {
-        strictly '8.2.0.v20160908'
-      }
-    }
-  }
-
   // Jetty 10 seems to refuse to run on java8.
   // TODO: we need to setup separate test for Jetty 10 when that is released.
   latestDepTestImplementation group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.+'

dd-java-agent/instrumentation/servlet/javax-servlet/javax-servlet-common/build.gradle

@@ -27,9 +27,3 @@ dependencies {
   testImplementation project(':dd-java-agent:instrumentation:jetty:jetty-util-9.4.31')
 }
 
-configurations.named('testImplementation') {
-  // Don't want to conflict with jetty from the test server.
-  // because :dd-java-agent:testing brings its own version of jetty-server
-  exclude(group: 'org.eclipse.jetty')
-}
-

dd-java-agent/instrumentation/tomcat/tomcat-5.5/build.gradle

@@ -143,12 +143,6 @@ tasks.withType(Test).configureEach {
     )
 }
 
-configurations.named('testImplementation') {
-  // Don't want to conflict with jetty from the test server.
-  // because :dd-java-agent:testing brings its own version of jetty-server
-  exclude(group: 'org.eclipse.jetty')
-}
-
 // Exclude all the dependencies from test for latestDepTest since the names are completely different.
 ["latestDepTestImplementation", "tomcat9TestImplementation", "latest10TestImplementation"].each {
   configurations.named(it) {

dd-java-agent/testing/build.gradle

@@ -38,7 +38,10 @@ dependencies {
   api libs.bundles.test.logging
   api libs.guava
 
-  api group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.4.56.v20240826'
+  // Jetty is bundled (relocated) in the shadow jar, not exposed as transitive dependency
+  // This avoids version conflicts with instrumentation tests that use different jetty versions
+  compileOnly group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.4.56.v20240826'
+  runtimeOnly group: 'org.eclipse.jetty', name: 'jetty-server', version: '9.4.56.v20240826'
   // ^ 9.4 last to support java 8
   api group: 'com.squareup.okhttp3', name: 'logging-interceptor', version: libs.versions.okhttp.legacy.get()
 
@@ -55,12 +58,34 @@ dependencies {
 }
 
 tasks.named("shadowJar", ShadowJar) {
+  // Only bundle jetty dependencies into the jar (relocated)
+  // All other dependencies remain as transitive dependencies
   dependencies {
     include(dependency {
       it.moduleGroup == 'org.eclipse.jetty'
     })
   }
+
+  // Relocate jetty classes to avoid conflicts with instrumented versions
   relocate "org.eclipse.jetty", "datadog.eclipse.jetty"
+
+  // Make shadowJar replace the main jar in api configuration
+  archiveClassifier = ''
+}
+
+// Remove the regular jar from api elements and use shadow jar instead
+// Also exclude jetty from being exposed as a transitive dependency (it's bundled in the shadow jar)
+configurations {
+  apiElements {
+    outgoing.artifacts.clear()
+    outgoing.artifact(tasks.shadowJar)
+    exclude group: 'org.eclipse.jetty'
+  }
+  runtimeElements {
+    outgoing.artifacts.clear()
+    outgoing.artifact(tasks.shadowJar)
+    exclude group: 'org.eclipse.jetty'
+  }
 }
 
 tasks.withType(Test).configureEach {