Support just released Javalin 7 (#16261)

Author: trask

.fossa.yml

@@ -178,9 +178,6 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:java-util-logging:javaagent'
-    - type: gradle
-      path: ./
-      target: ':instrumentation:javalin-5.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:jaxrs-client:jaxrs-client-1.1-testing'
@@ -541,6 +538,12 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:internal:internal-url-class-loader:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:javalin:javalin-5.0:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:javalin:javalin-7.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:jaxrs:jaxrs-1.0:javaagent'

instrumentation/javalin-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinTest.java

@@ -20,8 +20,11 @@ otelJava {
 dependencies {
   library("io.javalin:javalin:5.0.0")
 
+  testImplementation(project(":instrumentation:javalin:testing"))
+
   testInstrumentation(project(":instrumentation:jetty:jetty-11.0:javaagent"))
+  // Ensure no cross interference
+  testInstrumentation(project(":instrumentation:javalin:javalin-7.0:javaagent"))
 
-  // TODO see https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/16261
-  latestDepTestLibrary("io.javalin:javalin:6.+") // documented limitation
+  latestDepTestLibrary("io.javalin:javalin:6.+") // see javalin-7.0 module
 }

instrumentation/javalin-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/TestJavalinJavaApplication.java

@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static java.util.Collections.singletonList;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
@@ -29,6 +30,8 @@ public List<TypeInstrumentation> typeInstrumentations() {
 
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    return hasClassesNamed("io.javalin.http.Handler");
+    // io.javalin.config.JavalinState was introduced in Javalin 7
+    return hasClassesNamed("io.javalin.http.Handler")
+        .and(not(hasClassesNamed("io.javalin.config.JavalinState")));
   }
 }

…n/javalin-5.0/javaagent/build.gradle.kts …n/javalin-5.0/javaagent/build.gradle.ktsinstrumentation/javalin-5.0/javaagent/build.gradle.kts renamed to instrumentation/javalin/javalin-5.0/javaagent/build.gradle.kts instrumentation/javalin-5.0/javaagent/build.gradle.kts renamed to instrumentation/javalin/javalin-5.0/javaagent/build.gradle.kts

@@ -0,0 +1,46 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javalin.v5_0;
+
+import io.javalin.Javalin;
+import io.opentelemetry.instrumentation.javalin.AbstractJavalinTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class JavalinTest extends AbstractJavalinTest {
+
+  @RegisterExtension
+  private static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  protected Javalin setupJavalin(int port) {
+    Javalin app = Javalin.create().start(port);
+    app.get(
+        "/param/{id}",
+        ctx -> {
+          String paramId = ctx.pathParam("id");
+          ctx.result(paramId);
+        });
+    app.get(
+        "/error",
+        ctx -> {
+          throw new RuntimeException("boom");
+        });
+    app.get("/async", ctx -> ctx.async(() -> ctx.result("ok")));
+    return app;
+  }
+
+  @Override
+  protected String getJettyInstrumentation() {
+    return "io.opentelemetry.jetty-11.0";
+  }
+}

…javalin/v5_0/JavalinInstrumentation.java …javalin/v5_0/JavalinInstrumentation.javainstrumentation/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentation.java renamed to instrumentation/javalin/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentation.java instrumentation/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentation.java renamed to instrumentation/javalin/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentation.java

@@ -0,0 +1,27 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("io.javalin")
+    module.set("javalin")
+    versions.set("[7.0.0,)")
+    assertInverse.set(true)
+  }
+}
+
+// javalin 7 requires java 17
+otelJava {
+  minJavaVersionSupported.set(JavaVersion.VERSION_17)
+}
+
+dependencies {
+  library("io.javalin:javalin:7.0.0")
+
+  testImplementation(project(":instrumentation:javalin:testing"))
+
+  testInstrumentation(project(":instrumentation:jetty:jetty-12.0:javaagent"))
+  // Ensure no cross interference
+  testInstrumentation(project(":instrumentation:javalin:javalin-5.0:javaagent"))
+}

…n/v5_0/JavalinInstrumentationModule.java …n/v5_0/JavalinInstrumentationModule.javainstrumentation/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentationModule.java renamed to instrumentation/javalin/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentationModule.java instrumentation/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentationModule.java renamed to instrumentation/javalin/javalin-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javalin/v5_0/JavalinInstrumentationModule.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javalin.v7_0;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasSuperType;
+import static net.bytebuddy.matcher.ElementMatchers.isInterface;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.not;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import io.javalin.http.Context;
+import io.opentelemetry.instrumentation.api.semconv.http.HttpServerRoute;
+import io.opentelemetry.instrumentation.api.semconv.http.HttpServerRouteSource;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class JavalinInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return hasSuperType(named("io.javalin.http.Handler")).and(not(isInterface()));
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        named("handle").and(takesArgument(0, named("io.javalin.http.Context"))),
+        this.getClass().getName() + "$HandlerAdapterAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class HandlerAdapterAdvice {
+
+    @Advice.OnMethodExit(suppress = Throwable.class, onThrowable = Throwable.class)
+    public static void onAfterExecute(@Advice.Argument(0) Context ctx, @Advice.Thrown Throwable t) {
+      HttpServerRoute.update(
+          io.opentelemetry.context.Context.current(),
+          HttpServerRouteSource.CONTROLLER,
+          ctx.endpoint().path);
+    }
+  }
+}