chore: check compatibility between reactor-core and lettuce (#15472)

Co-authored-by: Lauri Tulmin <[email protected]>

Author: 123liuziming

instrumentation/lettuce/lettuce-5.1/javaagent/build.gradle.kts

@@ -43,3 +43,22 @@ tasks {
     dependsOn(testStableSemconv)
   }
 }
+
+testing {
+  suites {
+    val testCompatibility by registering(JvmTestSuite::class) {
+      dependencies {
+        implementation("io.lettuce:lettuce-core:6.1.10.RELEASE")
+        implementation("io.projectreactor:reactor-core:3.5.3")
+        implementation("org.testcontainers:testcontainers")
+        implementation(project(":instrumentation:lettuce:lettuce-5.1:testing"))
+      }
+    }
+  }
+}
+
+tasks {
+  check {
+    dependsOn(testing.suites)
+  }
+}

instrumentation/lettuce/lettuce-5.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/lettuce/v5_1/CompatibilityChecker.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.lettuce.v5_1;
+
+import io.lettuce.core.tracing.Tracing;
+
+public final class CompatibilityChecker {
+
+  private CompatibilityChecker() {}
+
+  private static final boolean isCompatible = isCompatible();
+
+  private static boolean isCompatible() {
+    try {
+      Tracing.getContext();
+      return true;
+    } catch (Throwable t) {
+      return false;
+    }
+  }
+
+  // related to https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/10997
+  // if users are using incompatible versions of reactor-core and lettuce
+  // then just disable the instrumentation
+  public static boolean checkCompatible() {
+    return isCompatible;
+  }
+}

instrumentation/lettuce/lettuce-5.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/lettuce/v5_1/DefaultClientResourcesInstrumentation.java

@@ -35,7 +35,9 @@ public static class BuilderAdvice {
 
     @Advice.OnMethodExit(suppress = Throwable.class)
     public static void methodEnter(@Advice.Return DefaultClientResources.Builder builder) {
-      builder.tracing(TracingHolder.TRACING);
+      if (CompatibilityChecker.checkCompatible()) {
+        builder.tracing(TracingHolder.TRACING);
+      }
     }
   }
 }

instrumentation/lettuce/lettuce-5.1/javaagent/src/testCompatibility/java/io/opentelemetry/javaagent/instrumentation/lettuce/v5_1/LettuceCompatibilityTest.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.lettuce.v5_1;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.lettuce.core.RedisClient;
+import io.lettuce.core.api.sync.RedisCommands;
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.instrumentation.lettuce.v5_1.AbstractLettuceClientTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class LettuceCompatibilityTest extends AbstractLettuceClientTest {
+  @RegisterExtension
+  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  public InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  protected RedisClient createClient(String uri) {
+    return RedisClient.create(uri);
+  }
+
+  private static RedisCommands<String, String> syncCommands;
+
+  @BeforeAll
+  void setUp() throws UnknownHostException {
+    redisServer.start();
+
+    host = redisServer.getHost();
+    ip = InetAddress.getByName(host).getHostAddress();
+    port = redisServer.getMappedPort(6379);
+    embeddedDbUri = "redis://" + host + ":" + port + "/" + DB_INDEX;
+
+    redisClient = createClient(embeddedDbUri);
+
+    connection = redisClient.connect();
+    syncCommands = connection.sync();
+
+    syncCommands.set("TESTKEY", "TESTVAL");
+  }
+
+  @AfterAll
+  static void cleanUp() {
+    connection.close();
+    redisClient.shutdown();
+    redisServer.stop();
+  }
+
+  @Test
+  void testInstrumentationDisabled() {
+    String res =
+        testing().runWithSpan("parent", () -> syncCommands.set("TESTSETKEY", "TESTSETVAL"));
+    assertThat(res).isEqualTo("OK");
+    testing()
+        .waitAndAssertTraces(
+            trace ->
+                trace.hasSpansSatisfyingExactly(
+                    span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent()));
+  }
+}