Enables jspecify (#1603)

spring-cloud-context

spring-cloud-commons

spring-cloud-loadbalancer

Author: spencergibb

.mvn/maven.config

@@ -1 +1,2 @@
--DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local -P spring
+-Djspecify.enabled=true
+-P spring

spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java

@@ -21,6 +21,8 @@
 import java.util.Map;
 import java.util.Objects;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Default implementation of {@link ServiceInstance}.
  *
@@ -31,19 +33,19 @@
  */
 public class DefaultServiceInstance implements ServiceInstance {
 
-	private String instanceId;
+	private @Nullable String instanceId;
 
-	private String serviceId;
+	private @Nullable String serviceId;
 
-	private String host;
+	private @Nullable String host;
 
 	private int port;
 
 	private boolean secure;
 
 	private Map<String, String> metadata = new LinkedHashMap<>();
 
-	private URI uri;
+	private @Nullable URI uri;
 
 	/**
 	 * @param instanceId the id of the instance.
@@ -53,14 +55,16 @@ public class DefaultServiceInstance implements ServiceInstance {
 	 * @param secure indicates whether or not the connection needs to be secure.
 	 * @param metadata a map containing metadata.
 	 */
-	public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure,
-			Map<String, String> metadata) {
+	public DefaultServiceInstance(@Nullable String instanceId, @Nullable String serviceId, @Nullable String host,
+			int port, boolean secure, @Nullable Map<String, String> metadata) {
 		this.instanceId = instanceId;
 		this.serviceId = serviceId;
 		this.host = host;
 		this.port = port;
 		this.secure = secure;
-		this.metadata = metadata;
+		if (metadata != null) {
+			this.metadata = metadata;
+		}
 	}
 
 	/**
@@ -70,7 +74,8 @@ public DefaultServiceInstance(String instanceId, String serviceId, String host,
 	 * @param port the port on which the service is running.
 	 * @param secure indicates whether or not the connection needs to be secure.
 	 */
-	public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure) {
+	public DefaultServiceInstance(@Nullable String instanceId, @Nullable String serviceId, @Nullable String host,
+			int port, boolean secure) {
 		this(instanceId, serviceId, host, port, secure, new LinkedHashMap<>());
 	}
 
@@ -104,17 +109,17 @@ public Map<String, String> getMetadata() {
 	}
 
 	@Override
-	public String getInstanceId() {
+	public @Nullable String getInstanceId() {
 		return instanceId;
 	}
 
 	@Override
-	public String getServiceId() {
+	public @Nullable String getServiceId() {
 		return serviceId;
 	}
 
 	@Override
-	public String getHost() {
+	public @Nullable String getHost() {
 		return host;
 	}
 

spring-cloud-commons/src/main/java/org/springframework/cloud/client/ServiceInstance.java

@@ -39,12 +39,12 @@ public interface ServiceInstance {
 	/**
 	 * @return The service ID as registered.
 	 */
-	String getServiceId();
+	@Nullable String getServiceId();
 
 	/**
 	 * @return The hostname of the registered service instance.
 	 */
-	String getHost();
+	@Nullable String getHost();
 
 	/**
 	 * @return The port of the registered service instance.
@@ -64,7 +64,7 @@ public interface ServiceInstance {
 	/**
 	 * @return The key / value pair metadata associated with the service instance.
 	 */
-	Map<String, String> getMetadata();
+	@Nullable Map<String, String> getMetadata();
 
 	/**
 	 * @return The scheme of the service instance.

spring-cloud-commons/src/main/java/org/springframework/cloud/client/circuitbreaker/httpservice/CircuitBreakerConfigurerUtils.java

@@ -48,6 +48,9 @@
  */
 final class CircuitBreakerConfigurerUtils {
 
+	/**
+	 * Default fallback key.
+	 */
 	public static final String DEFAULT_FALLBACK_KEY = "default";
 
 	private CircuitBreakerConfigurerUtils() {

spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/EnableDiscoveryClientImportSelector.java

@@ -43,7 +43,10 @@ public String[] selectImports(AnnotationMetadata metadata) {
 		AnnotationAttributes attributes = AnnotationAttributes
 			.fromMap(metadata.getAnnotationAttributes(getAnnotationClass().getName(), true));
 
-		boolean autoRegister = attributes.getBoolean("autoRegister");
+		boolean autoRegister = true;
+		if (attributes != null) {
+			autoRegister = attributes.getBoolean("autoRegister");
+		}
 
 		if (autoRegister) {
 			List<String> importsList = new ArrayList<>(Arrays.asList(imports));

spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/CompletionContext.java

@@ -16,6 +16,8 @@
 
 package org.springframework.cloud.client.loadbalancer;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.style.ToStringCreator;
 
 /**
@@ -29,11 +31,11 @@ public class CompletionContext<RES, T, C> {
 
 	private final Status status;
 
-	private final Throwable throwable;
+	private final @Nullable Throwable throwable;
 
-	private final Response<T> loadBalancerResponse;
+	private final @Nullable Response<T> loadBalancerResponse;
 
-	private final RES clientResponse;
+	private final @Nullable RES clientResponse;
 
 	private final Request<C> loadBalancerRequest;
 
@@ -55,8 +57,8 @@ public CompletionContext(Status status, Request<C> loadBalancerRequest, Response
 		this(status, null, loadBalancerRequest, loadBalancerResponse, clientResponse);
 	}
 
-	public CompletionContext(Status status, Throwable throwable, Request<C> loadBalancerRequest,
-			Response<T> loadBalancerResponse, RES clientResponse) {
+	public CompletionContext(Status status, @Nullable Throwable throwable, Request<C> loadBalancerRequest,
+			@Nullable Response<T> loadBalancerResponse, @Nullable RES clientResponse) {
 		this.status = status;
 		this.throwable = throwable;
 		this.loadBalancerRequest = loadBalancerRequest;
@@ -68,15 +70,15 @@ public Status status() {
 		return this.status;
 	}
 
-	public Throwable getThrowable() {
+	public @Nullable Throwable getThrowable() {
 		return this.throwable;
 	}
 
-	public Response<T> getLoadBalancerResponse() {
+	public @Nullable Response<T> getLoadBalancerResponse() {
 		return loadBalancerResponse;
 	}
 
-	public RES getClientResponse() {
+	public @Nullable RES getClientResponse() {
 		return clientResponse;
 	}
 

spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/DefaultRequest.java

@@ -30,8 +30,9 @@ public class DefaultRequest<T> implements Request<T> {
 
 	private T context;
 
+	@SuppressWarnings("unchecked")
 	public DefaultRequest() {
-		new DefaultRequestContext();
+		this((T) new DefaultRequestContext());
 	}
 
 	public DefaultRequest(T context) {

spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/DefaultRequestContext.java

@@ -18,6 +18,8 @@
 
 import java.util.Objects;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.style.ToStringCreator;
 
 /**
@@ -31,22 +33,22 @@ public class DefaultRequestContext extends HintRequestContext {
 	 * The request to be executed against the service instance selected by the
 	 * LoadBalancer.
 	 */
-	private final Object clientRequest;
+	private final @Nullable Object clientRequest;
 
 	public DefaultRequestContext() {
 		clientRequest = null;
 	}
 
-	public DefaultRequestContext(Object clientRequest) {
+	public DefaultRequestContext(@Nullable Object clientRequest) {
 		this.clientRequest = clientRequest;
 	}
 
-	public DefaultRequestContext(Object clientRequest, String hint) {
+	public DefaultRequestContext(@Nullable Object clientRequest, String hint) {
 		super(hint);
 		this.clientRequest = clientRequest;
 	}
 
-	public Object getClientRequest() {
+	public @Nullable Object getClientRequest() {
 		return clientRequest;
 	}
 

spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/DefaultResponse.java

@@ -18,6 +18,8 @@
 
 import java.util.Objects;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.cloud.client.ServiceInstance;
 import org.springframework.core.style.ToStringCreator;
 
@@ -27,7 +29,7 @@
  */
 public class DefaultResponse implements Response<ServiceInstance> {
 
-	private final ServiceInstance serviceInstance;
+	private final @Nullable ServiceInstance serviceInstance;
 
 	public DefaultResponse(ServiceInstance serviceInstance) {
 		this.serviceInstance = serviceInstance;
@@ -39,7 +41,7 @@ public boolean hasServer() {
 	}
 
 	@Override
-	public ServiceInstance getServer() {
+	public @Nullable ServiceInstance getServer() {
 		return this.serviceInstance;
 	}
 

spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/DeferringLoadBalancerInterceptor.java

@@ -18,6 +18,8 @@
 
 import java.io.IOException;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.http.HttpRequest;
 import org.springframework.http.client.ClientHttpRequestExecution;
@@ -37,14 +39,15 @@ public class DeferringLoadBalancerInterceptor implements ClientHttpRequestInterc
 
 	private final ObjectProvider<BlockingLoadBalancerInterceptor> loadBalancerInterceptorProvider;
 
-	private BlockingLoadBalancerInterceptor delegate;
+	private @Nullable BlockingLoadBalancerInterceptor delegate;
 
 	public DeferringLoadBalancerInterceptor(
 			ObjectProvider<BlockingLoadBalancerInterceptor> loadBalancerInterceptorProvider) {
 		this.loadBalancerInterceptorProvider = loadBalancerInterceptorProvider;
 	}
 
 	@Override
+	@SuppressWarnings("NullAway") // nullability checked in tryResolveDelegate()
 	public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
 			throws IOException {
 		tryResolveDelegate();