Add nullability annotations to module/spring-boot-data-commons

See gh-46587

Author: mhalbritter

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/autoconfigure/metrics/DataMetricsProperties.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.data.autoconfigure.metrics;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -73,7 +75,7 @@ public static class Autotime {
 			/**
 			 * Percentiles for which additional time series should be published.
 			 */
-			private double[] percentiles;
+			private double @Nullable [] percentiles;
 
 			public boolean isEnabled() {
 				return this.enabled;
@@ -91,11 +93,11 @@ public void setPercentilesHistogram(boolean percentilesHistogram) {
 				this.percentilesHistogram = percentilesHistogram;
 			}
 
-			public double[] getPercentiles() {
+			public double @Nullable [] getPercentiles() {
 				return this.percentiles;
 			}
 
-			public void setPercentiles(double[] percentiles) {
+			public void setPercentiles(double @Nullable [] percentiles) {
 				this.percentiles = percentiles;
 			}
 

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/autoconfigure/metrics/MetricsRepositoryMethodInvocationListenerBeanPostProcessor.java

@@ -22,6 +22,7 @@
 import org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport;
 import org.springframework.data.repository.core.support.RepositoryFactoryCustomizer;
 import org.springframework.data.repository.core.support.RepositoryFactorySupport;
+import org.springframework.util.Assert;
 import org.springframework.util.function.SingletonSupplier;
 
 /**
@@ -58,7 +59,9 @@ private MetricsRepositoryFactoryCustomizer(
 
 		@Override
 		public void customize(RepositoryFactorySupport repositoryFactory) {
-			repositoryFactory.addInvocationListener(this.listenerSupplier.get());
+			MetricsRepositoryMethodInvocationListener listener = this.listenerSupplier.get();
+			Assert.state(listener != null, "'listener' must not be null");
+			repositoryFactory.addInvocationListener(listener);
 		}
 
 	}

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/autoconfigure/metrics/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Spring Data repository metrics.
  */
+@NullMarked
 package org.springframework.boot.data.autoconfigure.metrics;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/autoconfigure/web/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Spring Data web.
  */
+@NullMarked
 package org.springframework.boot.data.autoconfigure.web;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/metrics/AutoTimer.java

@@ -23,6 +23,7 @@
 import io.micrometer.core.annotation.Timed;
 import io.micrometer.core.instrument.Timer;
 import io.micrometer.core.instrument.Timer.Builder;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.util.CollectionUtils;
 
@@ -98,7 +99,8 @@ default Timer.Builder builder(Supplier<Timer.Builder> supplier) {
 	 */
 	void apply(Timer.Builder builder);
 
-	static void apply(AutoTimer autoTimer, String metricName, Set<Timed> annotations, Consumer<Timer.Builder> action) {
+	static void apply(@Nullable AutoTimer autoTimer, String metricName, Set<Timed> annotations,
+			Consumer<Timer.Builder> action) {
 		if (!CollectionUtils.isEmpty(annotations)) {
 			for (Timed annotation : annotations) {
 				action.accept(Timer.builder(annotation, metricName));

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/metrics/DefaultRepositoryTagsProvider.java

@@ -21,8 +21,10 @@
 
 import io.micrometer.core.instrument.Tag;
 import io.micrometer.core.instrument.Tags;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocation;
+import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocationResult;
 import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocationResult.State;
 import org.springframework.util.StringUtils;
 
@@ -41,16 +43,20 @@ public Iterable<Tag> repositoryTags(RepositoryMethodInvocation invocation) {
 		Tags tags = Tags.empty();
 		tags = and(tags, invocation.getRepositoryInterface(), "repository", this::getSimpleClassName);
 		tags = and(tags, invocation.getMethod(), "method", Method::getName);
-		tags = and(tags, invocation.getResult().getState(), "state", State::name);
-		tags = and(tags, invocation.getResult().getError(), "exception", this::getExceptionName, EXCEPTION_NONE);
+		RepositoryMethodInvocationResult result = invocation.getResult();
+		if (result != null) {
+			tags = and(tags, result.getState(), "state", State::name);
+			tags = and(tags, result.getError(), "exception", this::getExceptionName, EXCEPTION_NONE);
+		}
 		return tags;
 	}
 
-	private <T> Tags and(Tags tags, T instance, String key, Function<T, String> value) {
+	private <T> Tags and(Tags tags, @Nullable T instance, String key, Function<T, String> value) {
 		return and(tags, instance, key, value, null);
 	}
 
-	private <T> Tags and(Tags tags, T instance, String key, Function<T, String> value, Tag fallback) {
+	private <T> Tags and(Tags tags, @Nullable T instance, String key, Function<T, String> value,
+			@Nullable Tag fallback) {
 		if (instance != null) {
 			return tags.and(key, value.apply(instance));
 		}

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/metrics/MetricsRepositoryMethodInvocationListener.java

@@ -23,8 +23,10 @@
 import io.micrometer.core.annotation.Timed;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tag;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener;
+import org.springframework.util.Assert;
 import org.springframework.util.function.SingletonSupplier;
 
 /**
@@ -53,7 +55,7 @@ public class MetricsRepositoryMethodInvocationListener implements RepositoryMeth
 	 * @since 4.0.0
 	 */
 	public MetricsRepositoryMethodInvocationListener(Supplier<MeterRegistry> registrySupplier,
-			RepositoryTagsProvider tagsProvider, String metricName, AutoTimer autoTimer) {
+			RepositoryTagsProvider tagsProvider, String metricName, @Nullable AutoTimer autoTimer) {
 		this.registrySupplier = (registrySupplier instanceof SingletonSupplier)
 				? (SingletonSupplier<MeterRegistry>) registrySupplier : SingletonSupplier.of(registrySupplier);
 		this.tagsProvider = tagsProvider;
@@ -66,11 +68,14 @@ public void afterInvocation(RepositoryMethodInvocation invocation) {
 		Set<Timed> annotations = TimedAnnotations.get(invocation.getMethod(), invocation.getRepositoryInterface());
 		Iterable<Tag> tags = this.tagsProvider.repositoryTags(invocation);
 		long duration = invocation.getDuration(TimeUnit.NANOSECONDS);
-		AutoTimer.apply(this.autoTimer, this.metricName, annotations,
-				(builder) -> builder.description("Duration of repository invocations")
-					.tags(tags)
-					.register(this.registrySupplier.get())
-					.record(duration, TimeUnit.NANOSECONDS));
+		AutoTimer.apply(this.autoTimer, this.metricName, annotations, (builder) -> {
+			MeterRegistry registry = this.registrySupplier.get();
+			Assert.state(registry != null, "'registry' must not be null");
+			builder.description("Duration of repository invocations")
+				.tags(tags)
+				.register(registry)
+				.record(duration, TimeUnit.NANOSECONDS);
+		});
 	}
 
 }

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/metrics/TimedAnnotations.java

@@ -23,6 +23,7 @@
 import java.util.Set;
 
 import io.micrometer.core.annotation.Timed;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.annotation.MergedAnnotationCollectors;
 import org.springframework.core.annotation.MergedAnnotations;
@@ -56,7 +57,7 @@ public static Set<Timed> get(Method method, Class<?> type) {
 		return findTimedAnnotations(type);
 	}
 
-	private static Set<Timed> findTimedAnnotations(AnnotatedElement element) {
+	private static Set<Timed> findTimedAnnotations(@Nullable AnnotatedElement element) {
 		if (element == null) {
 			return Collections.emptySet();
 		}

module/spring-boot-data-commons/src/main/java/org/springframework/boot/data/metrics/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Spring Data repository metrics.
  */
+@NullMarked
 package org.springframework.boot.data.metrics;
+
+import org.jspecify.annotations.NullMarked;