add nullaway

Author: zeitlinger

instrumentation-api/build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
   id("otel.japicmp-conventions")
   id("otel.publish-conventions")
   id("otel.jmh-conventions")
+  id("otel.nullaway-conventions")
 }
 
 group = "io.opentelemetry.instrumentation"

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/UnsafeAttributes.java

@@ -12,6 +12,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.BiConsumer;
+import javax.annotation.Nullable;
 
 /**
  * The {@link AttributesBuilder} and {@link Attributes} used by the instrumentation API. We are able
@@ -29,6 +30,7 @@ final class UnsafeAttributes extends HashMap<AttributeKey<?>, Object>
 
   @SuppressWarnings("unchecked")
   @Override
+  @Nullable
   public <T> T get(AttributeKey<T> key) {
     return (T) super.get(key);
   }
@@ -62,7 +64,7 @@ public <T> AttributesBuilder put(AttributeKey<Long> key, int value) {
 
   @Override
   @CanIgnoreReturnValue
-  public <T> AttributesBuilder put(AttributeKey<T> key, T value) {
+  public <T> AttributesBuilder put(AttributeKey<T> key, @Nullable T value) {
     super.put(key, value);
     return this;
   }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ContextPropagationDebug.java

@@ -45,7 +45,7 @@ public final class ContextPropagationDebug {
   private final Context sourceContext;
   private final List<Propagation> locations;
   // context after adding debug locations
-  private Context wrappedContext;
+  @Nullable private Context wrappedContext;
 
   private ContextPropagationDebug(Context sourceContext) {
     this.sourceContext = sourceContext;

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/HttpProtocolUtil.java

@@ -13,13 +13,15 @@
  */
 public final class HttpProtocolUtil {
 
+  @Nullable
   public static String getProtocol(@Nullable String protocol) {
     if (protocol != null && protocol.startsWith("HTTP/")) {
       return "http";
     }
     return null;
   }
 
+  @Nullable
   public static String getVersion(@Nullable String protocol) {
     if (protocol != null && protocol.startsWith("HTTP/")) {
       return normalizeHttpVersion(protocol.substring("HTTP/".length()));

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/HttpRouteState.java

@@ -40,7 +40,10 @@ public static HttpRouteState create(
 
   // this method is used reflectively from InstrumentationApiContextBridging
   public static HttpRouteState create(
-      @Nullable String method, @Nullable String route, int updatedBySourceOrder, Span span) {
+      @Nullable String method,
+      @Nullable String route,
+      int updatedBySourceOrder,
+      @Nullable Span span) {
     return new HttpRouteState(method, route, updatedBySourceOrder, span);
   }
 
@@ -50,7 +53,10 @@ public static HttpRouteState create(
   @Nullable private volatile Span span;
 
   private HttpRouteState(
-      @Nullable String method, @Nullable String route, int updatedBySourceOrder, Span span) {
+      @Nullable String method,
+      @Nullable String route,
+      int updatedBySourceOrder,
+      @Nullable Span span) {
     this.method = method;
     this.updatedBySourceOrder = updatedBySourceOrder;
     this.route = route;

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/InstrumenterUtil.java

@@ -19,6 +19,7 @@
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
+@SuppressWarnings("NullAway") // setters called in static initializer
 public final class InstrumenterUtil {
 
   private static InstrumenterAccess instrumenterAccess;

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/cache/WeakLockFreeCache.java

@@ -7,6 +7,7 @@
 
 import io.opentelemetry.instrumentation.api.internal.cache.weaklockfree.WeakConcurrentMap;
 import java.util.function.Function;
+import javax.annotation.Nullable;
 
 final class WeakLockFreeCache<K, V> implements Cache<K, V> {
 
@@ -22,6 +23,7 @@ public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction
   }
 
   @Override
+  @Nullable
   public V get(K key) {
     return delegate.getIfPresent(key);
   }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/cache/weaklockfree/AbstractWeakConcurrentMap.java

@@ -25,6 +25,8 @@
 
 package io.opentelemetry.instrumentation.api.internal.cache.weaklockfree;
 
+import static java.util.Objects.requireNonNull;
+
 import java.lang.ref.Reference;
 import java.lang.ref.ReferenceQueue;
 import java.lang.ref.WeakReference;
@@ -81,6 +83,7 @@ protected AbstractWeakConcurrentMap(ConcurrentMap<WeakKey<K>, V> target) {
    * @param key The key of the entry.
    * @return The value of the entry or the default value if it did not exist.
    */
+  @Nullable
   public V get(K key) {
     if (key == null) {
       throw new NullPointerException();
@@ -108,6 +111,7 @@ public V get(K key) {
    * @param key The key of the entry.
    * @return The value of the entry or null if it did not exist.
    */
+  @Nullable
   public V getIfPresent(K key) {
     if (key == null) {
       throw new NullPointerException();
@@ -225,6 +229,7 @@ public void clear() {
    * @return The default value for a key without value or {@code null} for not defining a default
    *     value.
    */
+  @Nullable
   protected V defaultValue(K key) {
     return null;
   }
@@ -332,7 +337,7 @@ public boolean equals(@Nullable Object other) {
       if (other instanceof WeakKey<?>) {
         return ((WeakKey<?>) other).get() == get();
       } else {
-        return other.equals(this);
+        return requireNonNull(other).equals(this);
       }
     }
 
@@ -346,9 +351,9 @@ private class EntryIterator implements Iterator<Map.Entry<K, V>> {
 
     private final Iterator<Map.Entry<WeakKey<K>, V>> iterator;
 
-    private Map.Entry<WeakKey<K>, V> nextEntry;
+    @Nullable private Map.Entry<WeakKey<K>, V> nextEntry;
 
-    private K nextKey;
+    @Nullable private K nextKey;
 
     private EntryIterator(Iterator<Map.Entry<WeakKey<K>, V>> iterator) {
       this.iterator = iterator;
@@ -378,7 +383,7 @@ public Map.Entry<K, V> next() {
         throw new NoSuchElementException();
       }
       try {
-        return new SimpleEntry(nextKey, nextEntry);
+        return new SimpleEntry(requireNonNull(nextKey), requireNonNull(nextEntry));
       } finally {
         findNext();
       }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/cache/weaklockfree/WeakConcurrentMap.java

@@ -25,6 +25,8 @@
 
 package io.opentelemetry.instrumentation.api.internal.cache.weaklockfree;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.Iterator;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -142,7 +144,7 @@ protected void resetLookupKey(LookupKey<K> lookupKey) {
   // can't use AutoClosable/try-with-resources as this project still supports Java 6
   static final class LookupKey<K> {
 
-    private K key;
+    @Nullable private K key;
     private int hashCode;
 
     @SuppressWarnings("OtelCanIgnoreReturnValueSuggester")
@@ -163,7 +165,7 @@ public boolean equals(@Nullable Object other) {
       if (other instanceof WeakConcurrentMap.LookupKey<?>) {
         return ((LookupKey<?>) other).key == key;
       } else {
-        return ((AbstractWeakConcurrentMap.WeakKey<?>) other).get() == key;
+        return ((AbstractWeakConcurrentMap.WeakKey<?>) requireNonNull(other)).get() == key;
       }
     }
 
@@ -183,12 +185,14 @@ public int hashCode() {
   public static class WithInlinedExpunction<K, V> extends WeakConcurrentMap<K, V> {
 
     @Override
+    @Nullable
     public V get(K key) {
       expungeStaleEntries();
       return super.get(key);
     }
 
     @Override
+    @Nullable
     public V getIfPresent(K key) {
       expungeStaleEntries();
       return super.getIfPresent(key);

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/cache/weaklockfree/WeakConcurrentMapCleaner.java

@@ -5,12 +5,14 @@
 
 package io.opentelemetry.instrumentation.api.internal.cache.weaklockfree;
 
+import javax.annotation.Nullable;
+
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
 public final class WeakConcurrentMapCleaner {
-  private static Thread thread;
+  @Nullable private static Thread thread;
 
   private WeakConcurrentMapCleaner() {}