remaining spring nullable (#15519)

zeitlinger · web-flow · commit 4b273aa09914 · 2025-12-10T14:33:09.000+02:00
diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerRoute.java b/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);
   }
 
diff --git a/instrumentation/spring/spring-web/spring-web-3.1/javaagent/build.gradle.kts b/instrumentation/spring/spring-web/spring-web-3.1/javaagent/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {
diff --git a/instrumentation/spring/spring-web/spring-web-6.0/javaagent/build.gradle.kts b/instrumentation/spring/spring-web/spring-web-6.0/javaagent/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {
diff --git a/instrumentation/spring/spring-web/spring-web-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/web/v6_0/RestTemplateInstrumentation.java b/instrumentation/spring/spring-web/spring-web-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/web/v6_0/RestTemplateInstrumentation.java
@@ -37,6 +37,7 @@ public void transform(TypeTransformer transformer) {
   public static class UrlTemplateAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
+    @Nullable
     public static Scope onEnter(@Advice.Argument(1) String uriTemplate) {
       if (uriTemplate != null) {
         String path = UrlParser.getPath(uriTemplate);
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/build.gradle.kts b/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 {
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/AdviceUtils.java b/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> {
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/RouteOnSuccess.java b/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
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/WebfluxSingletons.java b/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;
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/build.gradle.kts b/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 {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webmvc/v3_1/SpringWebMvcServerSpanNaming.java b/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) {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/build.gradle.kts b/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"
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/HttpRouteSupport.java b/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) {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/JavaxHttpServletRequestGetter.java b/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/JavaxHttpServletRequestGetter.java
@@ -9,6 +9,7 @@
 import io.opentelemetry.instrumentation.api.internal.EnumerationUtil;
 import java.util.Collections;
 import java.util.Iterator;
+import javax.annotation.Nullable;
 import javax.servlet.http.HttpServletRequest;
 
 enum JavaxHttpServletRequestGetter implements TextMapGetter<HttpServletRequest> {
@@ -20,12 +21,19 @@ public Iterable<String> keys(HttpServletRequest carrier) {
   }
 
   @Override
-  public String get(HttpServletRequest carrier, String key) {
+  @Nullable
+  public String get(@Nullable HttpServletRequest carrier, String key) {
+    if (carrier == null) {
+      return null;
+    }
     return carrier.getHeader(key);
   }
 
   @Override
-  public Iterator<String> getAll(HttpServletRequest carrier, String key) {
+  public Iterator<String> getAll(@Nullable HttpServletRequest carrier, String key) {
+    if (carrier == null) {
+      return Collections.emptyIterator();
+    }
     return EnumerationUtil.asIterator(carrier.getHeaders(key));
   }
 }
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/internal/SpringMvcBuilderUtil.java b/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/internal/SpringMvcBuilderUtil.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.spring.webmvc.v5_3.internal;
 
 import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpServerInstrumenterBuilder;
+import io.opentelemetry.instrumentation.api.internal.Initializer;
 import io.opentelemetry.instrumentation.spring.webmvc.v5_3.SpringWebMvcTelemetryBuilder;
 import java.util.function.Function;
 import javax.servlet.http.HttpServletRequest;
@@ -31,6 +32,7 @@ private SpringMvcBuilderUtil() {}
     return builderExtractor;
   }
 
+  @Initializer
   public static void setBuilderExtractor(
       Function<
               SpringWebMvcTelemetryBuilder,
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/build.gradle.kts b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webmvc/v6_0/SpringWebMvcServerSpanNaming.java b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/webmvc/v6_0/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) {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/build.gradle.kts b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.library-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 dependencies {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/HttpRouteSupport.java b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/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) {
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/JakartaHttpServletRequestGetter.java b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/JakartaHttpServletRequestGetter.java
@@ -10,6 +10,7 @@
 import jakarta.servlet.http.HttpServletRequest;
 import java.util.Collections;
 import java.util.Iterator;
+import javax.annotation.Nullable;
 
 enum JakartaHttpServletRequestGetter implements TextMapGetter<HttpServletRequest> {
   INSTANCE;
@@ -20,12 +21,19 @@ public Iterable<String> keys(HttpServletRequest carrier) {
   }
 
   @Override
-  public String get(HttpServletRequest carrier, String key) {
+  @Nullable
+  public String get(@Nullable HttpServletRequest carrier, String key) {
+    if (carrier == null) {
+      return null;
+    }
     return carrier.getHeader(key);
   }
 
   @Override
-  public Iterator<String> getAll(HttpServletRequest carrier, String key) {
+  public Iterator<String> getAll(@Nullable HttpServletRequest carrier, String key) {
+    if (carrier == null) {
+      return Collections.emptyIterator();
+    }
     return EnumerationUtil.asIterator(carrier.getHeaders(key));
   }
 }
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/internal/SpringMvcBuilderUtil.java b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/internal/SpringMvcBuilderUtil.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.spring.webmvc.v6_0.internal;
 
 import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpServerInstrumenterBuilder;
+import io.opentelemetry.instrumentation.api.internal.Initializer;
 import io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetryBuilder;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
@@ -31,6 +32,7 @@ private SpringMvcBuilderUtil() {}
     return builderExtractor;
   }
 
+  @Initializer
   public static void setBuilderExtractor(
       Function<
               SpringWebMvcTelemetryBuilder,
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-common/javaagent/build.gradle.kts b/instrumentation/spring/spring-webmvc/spring-webmvc-common/javaagent/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 dependencies {
diff --git a/instrumentation/spring/spring-ws-2.0/javaagent/build.gradle.kts b/instrumentation/spring/spring-ws-2.0/javaagent/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
   id("otel.javaagent-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 muzzle {
diff --git a/instrumentation/spring/spring-ws-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/ws/v2_0/AnnotatedMethodInstrumentation.java b/instrumentation/spring/spring-ws-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/ws/v2_0/AnnotatedMethodInstrumentation.java
@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.instrumentation.spring.ws.v2_0.SpringWsSingletons.instrumenter;
+import static java.util.Objects.requireNonNull;
 import static net.bytebuddy.matcher.ElementMatchers.declaresMethod;
 import static net.bytebuddy.matcher.ElementMatchers.isAnnotatedWith;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
@@ -53,12 +54,15 @@ public static class AnnotatedMethodAdvice {
 
     public static class AdviceScope {
       private final CallDepth callDepth;
-      private final SpringWsRequest request;
-      private final Context context;
-      private final Scope scope;
+      @Nullable private final SpringWsRequest request;
+      @Nullable private final Context context;
+      @Nullable private final Scope scope;
 
       private AdviceScope(
-          CallDepth callDepth, SpringWsRequest request, Context context, Scope scope) {
+          CallDepth callDepth,
+          @Nullable SpringWsRequest request,
+          @Nullable Context context,
+          @Nullable Scope scope) {
         this.callDepth = callDepth;
         this.request = request;
         this.context = context;
@@ -88,7 +92,8 @@ public void exit(@Nullable Throwable throwable) {
           return;
         }
         scope.close();
-        instrumenter().end(context, request, null, throwable);
+        // scope non-null implies context and request are both non-null (see enter method above)
+        instrumenter().end(requireNonNull(context), requireNonNull(request), null, throwable);
       }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`plugins {`
`2`	`2`	`id("otel.javaagent-instrumentation")`
	`3`	`+ id("otel.nullaway-conventions")`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`muzzle {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public static <T> Mono<T> wrapMono(Mono<T> mono, Context context) {`
`50`	`50`
`51`	`51`	`@FunctionalInterface`
`52`	`52`	`interface OnSpanEnd {`
`53`		`- void end(Throwable throwable);`
	`53`	`+ void end(@Nullable Throwable throwable);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`private static class ContextMono<T> extends Mono<T> {`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public void accept(HandlerFunction<?> handler) {`
`32`	`32`	`HttpServerRoute.update(Context.current(), HttpServerRouteSource.CONTROLLER, route);`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ @Nullable`
`35`	`36`	`private static String parsePredicateString(RouterFunction<?> routerFunction) {`
`36`	`37`	`String routerFunctionString = routerFunction.toString();`
`37`	`38`	`// Router functions containing lambda predicates should not end up in span tags since they are`