ServiceTalk Captured Context API Instrumentation for v0.42.56+

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

@@ -1,39 +1 @@
-plugins {
-  id 'java-test-fixtures'
-}
-
-muzzle {
-  pass {
-    group = 'io.servicetalk'
-    module = 'servicetalk-concurrent-api'
-    // prev versions missing ContextMap
-    versions = '[0.41.12,)'
-    assertInverse = true
-  }
-  pass {
-    group = 'io.servicetalk'
-    module = 'servicetalk-context-api'
-    versions = '[0.1.0,)'
-    assertInverse = true
-  }
-}
-
-ext {
-  minJavaVersionForTests = JavaVersion.VERSION_11
-}
-
 apply from: "$rootDir/gradle/java.gradle"
-
-addTestSuiteForDir('latestDepTest', 'test')
-
-dependencies {
-  compileOnly group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.45'
-  compileOnly group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.45'
-
-  testImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.0'
-  testImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.0'
-
-  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '+'
-  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '+'
-}
-

dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.0/build.gradle

@@ -0,0 +1,39 @@
+plugins {
+  id 'java-test-fixtures'
+}
+
+muzzle {
+  pass {
+    group = 'io.servicetalk'
+    module = 'servicetalk-concurrent-api'
+    versions = '[0.42.0,0.42.55]'
+  }
+  fail {
+    group = 'io.servicetalk'
+    module = 'servicetalk-concurrent-api'
+    versions = '(0.42.55,]'
+  }
+}
+
+ext {
+  minJavaVersionForTests = JavaVersion.VERSION_11
+}
+
+apply from: "$rootDir/gradle/java.gradle"
+
+addTestSuiteForDir('latestDepTest', 'test')
+
+dependencies {
+  compileOnly group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.0'
+  compileOnly group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.0'
+
+  testImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.42'
+  testImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.42'
+
+  // import the newer instrumentation into the test to ensure that it does not interfere with it
+  testRuntimeOnly project(":dd-java-agent:instrumentation:servicetalk:servicetalk-0.42.56")
+
+  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.55'
+  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.55'
+}
+

dd-java-agent/instrumentation/servicetalk/src/main/java/datadog/trace/instrumentation/servicetalk/ContextMapInstrumentation.java → dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.0/src/main/java/datadog/trace/instrumentation/servicetalk0_42_0/ContextMapInstrumentation.java

@@ -1,4 +1,4 @@
-package datadog.trace.instrumentation.servicetalk;
+package datadog.trace.instrumentation.servicetalk0_42_0;
 
 import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
@@ -16,7 +16,7 @@
 import net.bytebuddy.asm.Advice;
 
 @AutoService(InstrumenterModule.class)
-public class ContextMapInstrumentation extends AbstractAsyncContextInstrumentation
+public class ContextMapInstrumentation extends ServiceTalkInstrumentation
     implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
 
   @Override
@@ -40,6 +40,8 @@ public void methodAdvice(MethodTransformer transformer) {
   private static final class Construct {
     @Advice.OnMethodExit(suppress = Throwable.class)
     public static void exit(@Advice.This ContextMap contextMap) {
+      // Capture an active span on ST context copy to support versions prior to 0.42.56 that did not
+      // have captureContext
       InstrumentationContext.get(ContextMap.class, AgentSpan.class)
           .put(contextMap, AgentTracer.activeSpan());
     }

dd-java-agent/instrumentation/servicetalk/src/main/java/datadog/trace/instrumentation/servicetalk/ContextPreservingInstrumentation.java → dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.0/src/main/java/datadog/trace/instrumentation/servicetalk0_42_0/ContextPreservingInstrumentation.java

@@ -1,4 +1,4 @@
-package datadog.trace.instrumentation.servicetalk;
+package datadog.trace.instrumentation.servicetalk0_42_0;
 
 import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.namedOneOf;
 
@@ -13,7 +13,7 @@
 import net.bytebuddy.asm.Advice;
 
 @AutoService(InstrumenterModule.class)
-public class ContextPreservingInstrumentation extends AbstractAsyncContextInstrumentation
+public class ContextPreservingInstrumentation extends ServiceTalkInstrumentation
     implements Instrumenter.ForKnownTypes, Instrumenter.HasMethodAdvice {
 
   @Override

dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.0/src/main/java/datadog/trace/instrumentation/servicetalk0_42_0/ServiceTalkInstrumentation.java

@@ -0,0 +1,31 @@
+package datadog.trace.instrumentation.servicetalk0_42_0;
+
+import datadog.trace.agent.tooling.InstrumenterModule;
+import datadog.trace.agent.tooling.muzzle.Reference;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import java.util.Collections;
+import java.util.Map;
+
+public abstract class ServiceTalkInstrumentation extends InstrumenterModule.Tracing {
+
+  public ServiceTalkInstrumentation() {
+    super("servicetalk", "servicetalk-concurrent");
+  }
+
+  @Override
+  public Map<String, String> contextStore() {
+    return Collections.singletonMap(
+        "io.servicetalk.context.api.ContextMap", AgentSpan.class.getName());
+  }
+
+  @Override
+  public Reference[] additionalMuzzleReferences() {
+    return new Reference[] {
+      // This check prevents older instrumentation from being applied to ServiceTalk v0.42.56+
+      new Reference.Builder("io.servicetalk.concurrent.api.DelegatingExecutor")
+          // Removed in v0.42.56
+          .withField(new String[0], 0, "delegate", "Lio/servicetalk/concurrent/api/Executor;")
+          .build(),
+    };
+  }
+}

dd-java-agent/instrumentation/servicetalk/src/test/groovy/ContextPreservingInstrumentationTest.groovy → dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.0/src/test/groovy/ContextPreservingInstrumentationTest.groovy

@@ -3,7 +3,6 @@ import datadog.trace.bootstrap.instrumentation.api.AgentScope
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer
 import io.servicetalk.concurrent.api.AsyncContext
 import io.servicetalk.context.api.ContextMap
-
 import java.util.concurrent.ExecutorService
 import java.util.concurrent.Executors
 
@@ -150,7 +149,7 @@ class ContextPreservingInstrumentationTest extends AgentTestRunner {
     }
   }
 
-  private childSpan() {
+  private static childSpan() {
     AgentTracer.startSpan("test", "child").finish()
   }
 }

dd-java-agent/instrumentation/servicetalk/servicetalk-0.42.56/build.gradle

@@ -0,0 +1,42 @@
+plugins {
+  id 'java-test-fixtures'
+}
+
+muzzle {
+  fail {
+    group = 'io.servicetalk'
+    module = 'servicetalk-concurrent-api'
+    versions = '[,0.42.56)'
+  }
+  pass {
+    group = 'io.servicetalk'
+    module = 'servicetalk-concurrent-api'
+    // 0.42.56 is the earliest version where CapturedContext is public
+    versions = '[0.42.56,]'
+  }
+}
+
+ext {
+  minJavaVersionForTests = JavaVersion.VERSION_11
+}
+
+apply from: "$rootDir/gradle/java.gradle"
+
+//addTestSuiteForDir('latestDepTest', 'test')
+// TODO currently 0.42.56 is the latest version. Enable this once the next (0.42.57) is out, add 'latestDepTest'
+
+dependencies {
+  compileOnly group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.56'
+  compileOnly group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.56'
+
+  testImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '0.42.56'
+  testImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '0.42.56'
+
+  // import the previous instrumentation into the test to ensure that it does not interfere with it
+  testRuntimeOnly project(":dd-java-agent:instrumentation:servicetalk:servicetalk-0.42.0")
+
+  // TODO currently 0.42.56 is the latest version. Enable this once the next (0.42.57) is out, add 'latestDepTest'
+  //  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-concurrent-api', version: '+'
+  //  latestDepTestImplementation group: 'io.servicetalk', name: 'servicetalk-context-api', version: '+'
+}
+