Add nullability annotations to module/spring-boot-graphql

See gh-46587

Author: mhalbritter

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/DefaultGraphQlSchemaCondition.java

@@ -35,6 +35,7 @@
 import org.springframework.core.io.support.ResourcePatternUtils;
 import org.springframework.core.type.AnnotatedTypeMetadata;
 import org.springframework.graphql.execution.GraphQlSource;
+import org.springframework.util.Assert;
 
 /**
  * {@link Condition} that checks whether a GraphQL schema has been defined in the
@@ -76,6 +77,7 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM
 				.items(ConditionMessage.Style.QUOTE, Arrays.asList(schema.getLocations())));
 		}
 		ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+		Assert.state(beanFactory != null, "'beanFactory' must not be null");
 		String[] customizerBeans = beanFactory.getBeanNamesForType(GraphQlSourceBuilderCustomizer.class, false, false);
 		if (customizerBeans.length != 0) {
 			match = true;

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/GraphQlAutoConfiguration.java

@@ -28,6 +28,7 @@
 import graphql.introspection.Introspection;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
@@ -204,7 +205,7 @@ GraphQlSourceBuilderCustomizer cursorStrategyCustomizer(CursorStrategy<?> cursor
 	static class GraphQlResourcesRuntimeHints implements RuntimeHintsRegistrar {
 
 		@Override
-		public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+		public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader) {
 			hints.resources().registerPattern("graphql/**/*.graphqls").registerPattern("graphql/**/*.gqls");
 		}
 

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/GraphQlCorsProperties.java

@@ -21,6 +21,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.boot.convert.DurationUnit;
@@ -72,7 +74,7 @@ public class GraphQlCorsProperties {
 	/**
 	 * Whether credentials are supported. When not set, credentials are not supported.
 	 */
-	private Boolean allowCredentials;
+	private @Nullable Boolean allowCredentials;
 
 	/**
 	 * How long the response from a pre-flight request can be cached by clients. If a
@@ -121,11 +123,11 @@ public void setExposedHeaders(List<String> exposedHeaders) {
 		this.exposedHeaders = exposedHeaders;
 	}
 
-	public Boolean getAllowCredentials() {
+	public @Nullable Boolean getAllowCredentials() {
 		return this.allowCredentials;
 	}
 
-	public void setAllowCredentials(Boolean allowCredentials) {
+	public void setAllowCredentials(@Nullable Boolean allowCredentials) {
 		this.allowCredentials = allowCredentials;
 	}
 
@@ -137,7 +139,7 @@ public void setMaxAge(Duration maxAge) {
 		this.maxAge = maxAge;
 	}
 
-	public CorsConfiguration toCorsConfiguration() {
+	public @Nullable CorsConfiguration toCorsConfiguration() {
 		if (CollectionUtils.isEmpty(this.allowedOrigins) && CollectionUtils.isEmpty(this.allowedOriginPatterns)) {
 			return null;
 		}

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/GraphQlProperties.java

@@ -19,6 +19,8 @@
 import java.time.Duration;
 import java.util.Arrays;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.core.io.Resource;
 
@@ -239,7 +241,7 @@ public static class Websocket {
 		/**
 		 * Path of the GraphQL WebSocket subscription endpoint.
 		 */
-		private String path;
+		private @Nullable String path;
 
 		/**
 		 * Time within which the initial {@code CONNECTION_INIT} type message must be
@@ -250,13 +252,13 @@ public static class Websocket {
 		/**
 		 * Maximum idle period before a server keep-alive ping is sent to client.
 		 */
-		private Duration keepAlive;
+		private @Nullable Duration keepAlive;
 
-		public String getPath() {
+		public @Nullable String getPath() {
 			return this.path;
 		}
 
-		public void setPath(String path) {
+		public void setPath(@Nullable String path) {
 			this.path = path;
 		}
 
@@ -268,11 +270,11 @@ public void setConnectionInitTimeout(Duration connectionInitTimeout) {
 			this.connectionInitTimeout = connectionInitTimeout;
 		}
 
-		public Duration getKeepAlive() {
+		public @Nullable Duration getKeepAlive() {
 			return this.keepAlive;
 		}
 
-		public void setKeepAlive(Duration keepAlive) {
+		public void setKeepAlive(@Nullable Duration keepAlive) {
 			this.keepAlive = keepAlive;
 		}
 
@@ -283,13 +285,13 @@ public static class Rsocket {
 		/**
 		 * Mapping of the RSocket message handler.
 		 */
-		private String mapping;
+		private @Nullable String mapping;
 
-		public String getMapping() {
+		public @Nullable String getMapping() {
 			return this.mapping;
 		}
 
-		public void setMapping(String mapping) {
+		public void setMapping(@Nullable String mapping) {
 			this.mapping = mapping;
 		}
 
@@ -300,26 +302,26 @@ public static class Sse {
 		/**
 		 * How frequently keep-alive messages should be sent.
 		 */
-		private Duration keepAlive;
+		private @Nullable Duration keepAlive;
 
 		/**
 		 * Time required for concurrent handling to complete.
 		 */
-		private Duration timeout;
+		private @Nullable Duration timeout;
 
-		public Duration getKeepAlive() {
+		public @Nullable Duration getKeepAlive() {
 			return this.keepAlive;
 		}
 
-		public void setKeepAlive(Duration keepAlive) {
+		public void setKeepAlive(@Nullable Duration keepAlive) {
 			this.keepAlive = keepAlive;
 		}
 
-		public Duration getTimeout() {
+		public @Nullable Duration getTimeout() {
 			return this.timeout;
 		}
 
-		public void setTimeout(Duration timeout) {
+		public void setTimeout(@Nullable Duration timeout) {
 			this.timeout = timeout;
 		}
 

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

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration classes for data integrations with GraphQL.
  */
+@NullMarked
 package org.springframework.boot.graphql.autoconfigure.data;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/observation/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Spring GraphQL observations.
  */
+@NullMarked
 package org.springframework.boot.graphql.autoconfigure.observation;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/package-info.java

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

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/reactive/GraphQlWebFluxAutoConfiguration.java

@@ -21,6 +21,7 @@
 import graphql.GraphQL;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 import reactor.core.publisher.Mono;
 
 import org.springframework.aot.hint.RuntimeHints;
@@ -118,7 +119,7 @@ RouterFunction<ServerResponse> graphQlRouterFunction(GraphQlHttpHandler httpHand
 		builder.POST(path, this::unsupportedMediaType);
 		builder.GET(path, this::onlyAllowPost);
 		if (properties.getGraphiql().isEnabled()) {
-			GraphiQlHandler graphQlHandler = new GraphiQlHandler(path, properties.getWebsocket().getPath());
+			GraphiQlHandler graphQlHandler = createGraphQlHandler(properties, path);
 			builder.GET(properties.getGraphiql().getPath(), graphQlHandler::handleRequest);
 		}
 		GraphQlSource graphQlSource = graphQlSourceProvider.getIfAvailable();
@@ -129,6 +130,12 @@ RouterFunction<ServerResponse> graphQlRouterFunction(GraphQlHttpHandler httpHand
 		return builder.build();
 	}
 
+	// https://github.com/spring-projects/spring-graphql/issues/1276
+	@SuppressWarnings("NullAway")
+	private GraphiQlHandler createGraphQlHandler(GraphQlProperties properties, String path) {
+		return new GraphiQlHandler(path, properties.getWebsocket().getPath());
+	}
+
 	private Mono<ServerResponse> unsupportedMediaType(ServerRequest request) {
 		return ServerResponse.status(HttpStatus.UNSUPPORTED_MEDIA_TYPE).headers(this::acceptJson).build();
 	}
@@ -196,7 +203,7 @@ HandlerMapping graphQlWebSocketEndpoint(GraphQlWebSocketHandler graphQlWebSocket
 	static class GraphiQlResourceHints implements RuntimeHintsRegistrar {
 
 		@Override
-		public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+		public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader) {
 			hints.resources().registerPattern("graphiql/index.html");
 		}
 

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/reactive/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration classes for WebFlux support in Spring GraphQL.
  */
+@NullMarked
 package org.springframework.boot.graphql.autoconfigure.reactive;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-graphql/src/main/java/org/springframework/boot/graphql/autoconfigure/rsocket/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration classes for RSocket integration with GraphQL.
  */
+@NullMarked
 package org.springframework.boot.graphql.autoconfigure.rsocket;
+
+import org.jspecify.annotations.NullMarked;