Use shadowJar to pull in dependencies instead of copy

Separated unit tests to different project to enable unit testing against the shadowJar.

Author: tylerbenson

instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3Advice.java

@@ -6,18 +6,11 @@
 package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
 import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.getSnippetInjectionHelper;
-import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.helper;
 
-import io.opentelemetry.context.Context;
-import io.opentelemetry.context.Scope;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
-import io.opentelemetry.javaagent.bootstrap.http.HttpServerResponseCustomizerHolder;
 import io.opentelemetry.javaagent.bootstrap.servlet.AppServerBridge;
-import io.opentelemetry.javaagent.bootstrap.servlet.MappingResolver;
-import io.opentelemetry.javaagent.instrumentation.servlet.ServletRequestContext;
 import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.snippet.Servlet3SnippetInjectingResponseWrapper;
 import javax.annotation.Nullable;
-import javax.servlet.Servlet;
 import javax.servlet.ServletRequest;
 import javax.servlet.ServletResponse;
 import javax.servlet.http.HttpServletRequest;
@@ -30,67 +23,6 @@
 @SuppressWarnings("unused")
 public class Servlet3Advice {
 
-  public static class AdviceScope {
-    private final CallDepth callDepth;
-    private final ServletRequestContext<HttpServletRequest> requestContext;
-    private final Context context;
-    private final Scope scope;
-
-    public AdviceScope(
-        CallDepth callDepth,
-        HttpServletRequest request,
-        HttpServletResponse response,
-        Object servletOrFilter) {
-      this.callDepth = callDepth;
-      this.callDepth.getAndIncrement();
-
-      Context currentContext = Context.current();
-      Context attachedContext = helper().getServerContext(request);
-      Context contextToUpdate;
-
-      requestContext = new ServletRequestContext<>(request, servletOrFilter);
-      if (attachedContext == null && helper().shouldStart(currentContext, requestContext)) {
-        context = helper().start(currentContext, requestContext);
-        helper().setAsyncListenerResponse(context, response);
-
-        contextToUpdate = context;
-      } else if (attachedContext != null
-          && helper().needsRescoping(currentContext, attachedContext)) {
-        // Given request already has a context associated with it.
-        // see the needsRescoping() javadoc for more explanation
-        contextToUpdate = attachedContext;
-        context = null;
-      } else {
-        // We are inside nested servlet/filter/app-server span, don't create new span
-        contextToUpdate = currentContext;
-        context = null;
-      }
-
-      // Update context with info from current request to ensure that server span gets the best
-      // possible name.
-      // In case server span was created by app server instrumentations calling updateContext
-      // returns a new context that contains servlet context path that is used in other
-      // instrumentations for naming server span.
-      MappingResolver mappingResolver = Servlet3Singletons.getMappingResolver(servletOrFilter);
-      boolean servlet = servletOrFilter instanceof Servlet;
-      contextToUpdate = helper().updateContext(contextToUpdate, request, mappingResolver, servlet);
-      scope = contextToUpdate.makeCurrent();
-
-      if (context != null) {
-        // Only trigger response customizer once, so only if server span was created here
-        HttpServerResponseCustomizerHolder.getCustomizer()
-            .customize(contextToUpdate, response, Servlet3Accessor.INSTANCE);
-      }
-    }
-
-    public void exit(
-        @Nullable Throwable throwable, HttpServletRequest request, HttpServletResponse response) {
-
-      boolean topLevel = callDepth.decrementAndGet() == 0;
-      helper().end(requestContext, request, response, throwable, topLevel, context, scope);
-    }
-  }
-
   @AssignReturned.ToArguments({
     @ToArgument(value = 0, index = 1),
     @ToArgument(value = 1, index = 2)
@@ -114,8 +46,8 @@ public static Object[] onEnter(
       response =
           new Servlet3SnippetInjectingResponseWrapper((HttpServletResponse) response, snippet);
     }
-    AdviceScope adviceScope =
-        new AdviceScope(
+    Servlet3RequestAdviceScope adviceScope =
+        new Servlet3RequestAdviceScope(
             CallDepth.forClass(AppServerBridge.getCallDepthKey()),
             (HttpServletRequest) request,
             (HttpServletResponse) response,
@@ -129,7 +61,7 @@ public static void stopSpan(
       @Advice.Argument(1) ServletResponse response,
       @Advice.Thrown @Nullable Throwable throwable,
       @Advice.Enter Object[] enterResult) {
-    AdviceScope adviceScope = (AdviceScope) enterResult[0];
+    Servlet3RequestAdviceScope adviceScope = (Servlet3RequestAdviceScope) enterResult[0];
     if (adviceScope == null
         || !(request instanceof HttpServletRequest)
         || !(response instanceof HttpServletResponse)) {

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/copied/Servlet3RequestAdviceScope.java renamed to instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3RequestAdviceScope.java

@@ -3,12 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.servlet.v3_0.copied;
+package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
-import static io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3Singletons.helper;
+import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.helper;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
+import io.opentelemetry.javaagent.bootstrap.CallDepth;
+import io.opentelemetry.javaagent.bootstrap.http.HttpServerResponseCustomizerHolder;
+import io.opentelemetry.javaagent.bootstrap.servlet.MappingResolver;
+import io.opentelemetry.javaagent.instrumentation.servlet.ServletRequestContext;
 import javax.annotation.Nullable;
 import javax.servlet.Servlet;
 import javax.servlet.http.HttpServletRequest;

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/copied/Servlet3ResponseAdviceScope.java renamed to instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3ResponseAdviceScope.java

@@ -3,13 +3,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.servlet.v3_0.copied;
+package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
-import static io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3Singletons.responseInstrumenter;
+import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.responseInstrumenter;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.instrumentation.api.incubator.semconv.util.ClassAndMethod;
+import io.opentelemetry.javaagent.bootstrap.CallDepth;
+import io.opentelemetry.javaagent.instrumentation.servlet.common.response.HttpServletResponseAdviceHelper;
 import javax.annotation.Nullable;
 
 public class Servlet3ResponseAdviceScope {

instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3ResponseSendAdvice.java

@@ -5,67 +5,23 @@
 
 package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
-import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.responseInstrumenter;
-
-import io.opentelemetry.context.Context;
-import io.opentelemetry.context.Scope;
-import io.opentelemetry.instrumentation.api.incubator.semconv.util.ClassAndMethod;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
-import io.opentelemetry.javaagent.instrumentation.servlet.common.response.HttpServletResponseAdviceHelper;
-import javax.annotation.Nullable;
 import javax.servlet.http.HttpServletResponse;
 import net.bytebuddy.asm.Advice;
 
 @SuppressWarnings("unused")
 public class Servlet3ResponseSendAdvice {
 
-  public static class AdviceScope {
-    private final CallDepth callDepth;
-    private final ClassAndMethod classAndMethod;
-    private final Context context;
-    private final Scope scope;
-
-    public AdviceScope(CallDepth callDepth, Class<?> declaringClass, String methodName) {
-      this.callDepth = callDepth;
-      if (callDepth.getAndIncrement() > 0) {
-        this.classAndMethod = null;
-        this.context = null;
-        this.scope = null;
-        return;
-      }
-      HttpServletResponseAdviceHelper.StartResult result =
-          HttpServletResponseAdviceHelper.startSpan(
-              responseInstrumenter(), declaringClass, methodName);
-      if (result != null) {
-        classAndMethod = result.getClassAndMethod();
-        context = result.getContext();
-        scope = result.getScope();
-      } else {
-        classAndMethod = null;
-        context = null;
-        scope = null;
-      }
-    }
-
-    public void exit(@Nullable Throwable throwable) {
-      if (callDepth.decrementAndGet() > 0) {
-        return;
-      }
-      HttpServletResponseAdviceHelper.stopSpan(
-          responseInstrumenter(), throwable, context, scope, classAndMethod);
-    }
-  }
-
   @Advice.OnMethodEnter(suppress = Throwable.class)
-  public static AdviceScope start(
+  public static Servlet3ResponseAdviceScope start(
       @Advice.Origin("#t") Class<?> declaringClass, @Advice.Origin("#m") String methodName) {
-    return new AdviceScope(
+    return new Servlet3ResponseAdviceScope(
         CallDepth.forClass(HttpServletResponse.class), declaringClass, methodName);
   }
 
   @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
   public static void stopSpan(
-      @Advice.Thrown Throwable throwable, @Advice.Enter AdviceScope adviceScope) {
+      @Advice.Thrown Throwable throwable, @Advice.Enter Servlet3ResponseAdviceScope adviceScope) {
     adviceScope.exit(throwable);
   }
 }

instrumentation/servlet/servlet-3.0/library-unit-tests/build.gradle.kts

@@ -0,0 +1,40 @@
+plugins {
+  id("otel.library-instrumentation")
+}
+
+// These tests are split out so we can unit test against the actual shadowed jar.
+
+dependencies {
+  testImplementation(project(":instrumentation:servlet:servlet-3.0:library", configuration = "shadow"))
+  testImplementation(project(":instrumentation:servlet:servlet-3.0:testing"))
+
+  testLibrary("org.eclipse.jetty:jetty-server:8.0.0.v20110901")
+  testLibrary("org.eclipse.jetty:jetty-servlet:8.0.0.v20110901")
+  testLibrary("org.apache.tomcat.embed:tomcat-embed-core:8.0.41")
+  testLibrary("org.apache.tomcat.embed:tomcat-embed-jasper:8.0.41")
+
+  latestDepTestLibrary("org.eclipse.jetty:jetty-server:10.+") // see servlet-5.0 module
+  latestDepTestLibrary("org.eclipse.jetty:jetty-servlet:10.+") // see servlet-5.0 module
+
+  latestDepTestLibrary("org.apache.tomcat.embed:tomcat-embed-core:9.+") // see servlet-5.0 module
+  latestDepTestLibrary("org.apache.tomcat.embed:tomcat-embed-jasper:9.+") // see servlet-5.0 module
+}
+
+tasks {
+  withType<Test>().configureEach {
+    // required on jdk17+ to allow tomcat to shutdown properly.
+    jvmArgs("--add-opens=java.base/java.util=ALL-UNNAMED")
+    jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+  }
+}
+
+// Servlet 3.0 in latest Jetty versions requires Java 11
+// However, projects that depend on this module are still be using Java 8 in testLatestDeps mode
+// Therefore, we need a separate project for servlet 3.0 tests
+val latestDepTest = findProperty("testLatestDeps") as Boolean
+
+if (latestDepTest) {
+  otelJava {
+    minJavaVersionSupported.set(JavaVersion.VERSION_11)
+  }
+}