Prevent Vert.x 4 session reaper from retaining request contexts (#12667)

fix: prevent Vert.x 4 session reaper from retaining requests

chore: allow Vert.x timer guard in agent jar budget

fix: limit Vert.x 4 session timer guard to 4.x

fix: keep Vert.x timer guard active without tracing

chore: restore agent jar size budget

refactor: share Vert.x session timer guard across 4 and 5

fix: scope Vert.x session timer guard to Vert.x

Co-authored-by: brice.dutheil <brice.dutheil@datadoghq.com>

Author: bric3

dd-java-agent/instrumentation/vertx/vertx-web/vertx-web-4.0/src/latestDepTest/java/server/LocalSessionStoreInstrumentationTest.java

@@ -0,0 +1,60 @@
+package server;
+
+import static datadog.trace.agent.test.assertions.SpanMatcher.span;
+import static datadog.trace.agent.test.assertions.TraceMatcher.trace;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import datadog.context.ContextScope;
+import datadog.trace.agent.test.AbstractInstrumentationTest;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import io.vertx.core.Vertx;
+import io.vertx.ext.web.sstore.LocalSessionStore;
+import io.vertx.ext.web.sstore.impl.LocalSessionStoreImpl;
+import org.junit.jupiter.api.Test;
+
+class LocalSessionStoreInstrumentationTest extends AbstractInstrumentationTest {
+  @Test
+  void initializingSessionStoreDoesNotRetainRequest() throws Exception {
+    Vertx vertx = Vertx.vertx();
+    try {
+      AgentSpan parent = startSpan("test", "parent");
+      LocalSessionStore store;
+      try (ContextScope ignored = activateSpan(parent)) {
+        store = LocalSessionStore.create(vertx, "initializing", 60_000);
+      } finally {
+        parent.finish();
+      }
+      try {
+        assertTrue(
+            writer.waitForTracesMax(1, 3), "Session-store timers retained the request trace");
+        assertTraces(trace(span().root().operationName("parent")));
+      } finally {
+        store.close();
+      }
+    } finally {
+      vertx.close().toCompletionStage().toCompletableFuture().get(10, SECONDS);
+    }
+  }
+
+  @Test
+  void rearmingSessionReaperDoesNotRetainRequest() throws Exception {
+    Vertx vertx = Vertx.vertx();
+    LocalSessionStore store = LocalSessionStore.create(vertx, "rearming", 60_000);
+    try {
+      AgentSpan parent = startSpan("test", "parent");
+      try (ContextScope ignored = activateSpan(parent)) {
+        ((LocalSessionStoreImpl) store).handle(0L);
+      } finally {
+        parent.finish();
+      }
+      assertTrue(writer.waitForTracesMax(1, 3), "Session reaper retained the request trace");
+      assertTraces(trace(span().root().operationName("parent")));
+    } finally {
+      store.close();
+      vertx.close().toCompletionStage().toCompletableFuture().get(10, SECONDS);
+    }
+  }
+}

…er/LocalSessionStoreInstrumentation.java …er/LocalSessionStoreInstrumentation.javadd-java-agent/instrumentation/vertx/vertx-web/vertx-web-5.0/src/main/java/datadog/trace/instrumentation/vertx_5_0/server/LocalSessionStoreInstrumentation.java renamed to dd-java-agent/instrumentation/vertx/vertx-web/vertx-web-4.0/src/main/java/datadog/trace/instrumentation/vertx_4_0/server/LocalSessionStoreInstrumentation.java dd-java-agent/instrumentation/vertx/vertx-web/vertx-web-5.0/src/main/java/datadog/trace/instrumentation/vertx_5_0/server/LocalSessionStoreInstrumentation.java renamed to dd-java-agent/instrumentation/vertx/vertx-web/vertx-web-4.0/src/main/java/datadog/trace/instrumentation/vertx_4_0/server/LocalSessionStoreInstrumentation.java

@@ -1,4 +1,4 @@
-package datadog.trace.instrumentation.vertx_5_0.server;
+package datadog.trace.instrumentation.vertx_4_0.server;
 
 import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.isAsyncPropagationEnabled;
@@ -21,7 +21,7 @@
 public final class LocalSessionStoreInstrumentation extends InstrumenterModule.ContextTracking
     implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
   public LocalSessionStoreInstrumentation() {
-    super("vertx", "vertx-5.0");
+    super("vertx");
   }
 
   @Override
@@ -31,7 +31,8 @@ public String instrumentedType() {
 
   @Override
   public Reference[] additionalMuzzleReferences() {
-    return new Reference[] {VertxVersionMatcher.HTTP_HEADERS_INTERNAL};
+    // Vert.x 3.9 has the same class and timer methods.
+    return new Reference[] {VertxVersionMatcher.HTTP_1X_SERVER_RESPONSE};
   }
 
   @Override