add nullaway to spring

Author: zeitlinger

conventions/src/main/kotlin/otel.nullaway-conventions.gradle.kts

@@ -18,15 +18,19 @@ nullaway {
 
 tasks {
   withType<JavaCompile>().configureEach {
-    options.errorprone.nullaway {
-      if (name.contains("test", ignoreCase = true)) {
-        disable()
-      } else {
-        error()
+    options.errorprone {
+      disable("RequireExplicitNullMarking") // is enabled by default is some spring projects
+
+      nullaway {
+        if (name.contains("test", ignoreCase = true)) {
+          disable()
+        } else {
+          error()
+        }
+        customInitializerAnnotations.add("org.openjdk.jmh.annotations.Setup")
+        excludedFieldAnnotations.add("org.mockito.Mock")
+        excludedFieldAnnotations.add("org.mockito.InjectMocks")
       }
-      customInitializerAnnotations.add("org.openjdk.jmh.annotations.Setup")
-      excludedFieldAnnotations.add("org.mockito.Mock")
-      excludedFieldAnnotations.add("org.mockito.InjectMocks")
     }
   }
 }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerRoute.java

@@ -57,7 +57,8 @@ private HttpServerRoute() {}
    * strictly lower priority than the provided {@link HttpServerRouteSource}, and the passed value
    * is non-null.
    */
-  public static void update(Context context, HttpServerRouteSource source, String httpRoute) {
+  public static void update(Context context, HttpServerRouteSource source,
+      @Nullable String httpRoute) {
     update(context, source, ConstantAdapter.INSTANCE, httpRoute);
   }
 
@@ -75,7 +76,7 @@ public static <T> void update(
       Context context,
       HttpServerRouteSource source,
       HttpServerRouteGetter<T> httpRouteGetter,
-      T arg1) {
+      @Nullable T arg1) {
     update(context, source, OneArgAdapter::get, arg1, httpRouteGetter);
   }
 

instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {

instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/AdviceUtils.java

@@ -50,7 +50,7 @@ public static <T> Mono<T> wrapMono(Mono<T> mono, Context context) {
 
   @FunctionalInterface
   interface OnSpanEnd {
-    void end(Throwable throwable);
+    void end(@Nullable Throwable throwable);
   }
 
   private static class ContextMono<T> extends Mono<T> {

instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/RouteOnSuccess.java

@@ -32,6 +32,7 @@ public void accept(HandlerFunction<?> handler) {
     HttpServerRoute.update(Context.current(), HttpServerRouteSource.CONTROLLER, route);
   }
 
+  @Nullable
   private static String parsePredicateString(RouterFunction<?> routerFunction) {
     String routerFunctionString = routerFunction.toString();
     // Router functions containing lambda predicates should not end up in span tags since they are

instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/WebfluxSingletons.java

@@ -39,6 +39,9 @@ public static Instrumenter<Object, Void> instrumenter() {
 
   public static HttpServerRouteGetter<ServerWebExchange> httpRouteGetter() {
     return (context, exchange) -> {
+      if (exchange == null) {
+        return null;
+      }
       Object bestPatternObj = exchange.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
       if (bestPatternObj == null) {
         return null;

instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {

instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webmvc/v3_1/SpringWebMvcServerSpanNaming.java

@@ -14,6 +14,9 @@ public class SpringWebMvcServerSpanNaming {
 
   public static final HttpServerRouteGetter<HttpServletRequest> SERVER_SPAN_NAME =
       (context, request) -> {
+        if (request == null) {
+          return null;
+        }
         Object bestMatchingPattern =
             request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
         if (bestMatchingPattern != null) {

instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
   id("otel.library-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 val springBootVersion = "2.6.15"

instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/HttpRouteSupport.java

@@ -96,7 +96,10 @@ private void setHandlerMappings(List<HandlerMapping> mappings) {
   }
 
   @Nullable
-  String getHttpRoute(Context context, HttpServletRequest request) {
+  String getHttpRoute(Context context, @Nullable HttpServletRequest request) {
+    if (request == null) {
+      return null;
+    }
     boolean parsePath = this.parseRequestPath;
     Object previousValue = null;
     if (parsePath) {