Migrate to JSpecify for nullability constraints

See #1150

Signed-off-by: Chris Bono <[email protected]>

Author: onobc

build.gradle

@@ -5,6 +5,7 @@ plugins {
 	alias(libs.plugins.grgit) apply false
 	alias(libs.plugins.versions)
 	alias(libs.plugins.version.catalog.update)
+	id 'io.spring.nullability' version '0.0.1' apply false
 }
 
 description = 'Spring for Apache Pulsar'
@@ -14,6 +15,7 @@ apply from: 'gradle/aggregate-jacoco-report.gradle'
 apply from: 'gradle/update-copyrights.gradle'
 apply from: 'gradle/version-catalog-update.gradle'
 apply from: 'gradle/java-conventions.gradle'
+apply from: 'gradle/nullability-conventions.gradle'
 
 allprojects {
 	group = 'org.springframework.pulsar'

buildSrc/src/main/java/org/springframework/pulsar/gradle/versions/UpdateProjectVersionTask.java

@@ -24,8 +24,7 @@
 import org.gradle.api.DefaultTask;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.VersionCatalogsExtension;
-
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 public abstract class UpdateProjectVersionTask extends DefaultTask {
 

gradle/libs.versions.toml

@@ -3,7 +3,7 @@
 caffeine = "3.2.2"
 commons-compress = "1.26.2"
 jackson = "2.19.1"
-jsr305 = "3.0.2"
+jspecify = "1.0.0"
 logback = "1.5.18"
 micrometer = "1.15.2"
 micrometer-docs-gen = "1.0.4"
@@ -43,7 +43,7 @@ protobuf-plugin = "0.9.5"
 # Product libs
 caffeine = { module = "com.github.ben-manes.caffeine:caffeine", version.ref = "caffeine" }
 jackson-bom = { module = "com.fasterxml.jackson:jackson-bom", version.ref = "jackson" }
-jsr305 = { module = "com.google.code.findbugs:jsr305", version.ref = "jsr305" }
+jspecify = { module = "org.jspecify:jspecify", version.ref = "jspecify" }
 logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "logback" }
 micrometer-bom = { module = "io.micrometer:micrometer-bom", version.ref = "micrometer" }
 micrometer-docs-gen = { module = "io.micrometer:micrometer-docs-generator", version.ref = "micrometer-docs-gen" }

gradle/nullability-conventions.gradle

@@ -0,0 +1,12 @@
+def javaProjects = [ 'spring-pulsar',
+					 'spring-pulsar-cache-provider',
+					 'spring-pulsar-cache-provider-caffeine',
+					 'spring-pulsar-reactive',
+					 'spring-pulsar-test' ]
+
+allprojects {
+	if (!javaProjects.contains(project.name)) {
+		return
+	}
+	apply plugin: 'io.spring.nullability'
+}

integration-tests/src/intTest/java/org/springframework/pulsar/inttest/function/PulsarFunctionAdministrationIntegrationTests.java

@@ -37,6 +37,7 @@
 import org.apache.pulsar.client.api.PulsarClientException;
 import org.apache.pulsar.common.io.SourceConfig;
 import org.apache.pulsar.common.policies.data.SourceStatus;
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.EnabledIf;
@@ -62,7 +63,6 @@
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.support.ResourcePatternUtils;
 import org.springframework.core.log.LogAccessor;
-import org.springframework.lang.Nullable;
 import org.springframework.pulsar.annotation.PulsarListener;
 import org.springframework.pulsar.function.PulsarFunctionAdministration;
 import org.springframework.pulsar.function.PulsarFunctionOperations.FunctionStopPolicy;

spring-pulsar-cache-provider-caffeine/src/main/java/org/springframework/pulsar/cache/provider/caffeine/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * Package containing components to support Pulsar Caffeine cache provider.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.pulsar.cache.provider.caffeine;

spring-pulsar-dependencies/spring-pulsar-dependencies.gradle

@@ -22,7 +22,7 @@ dependencies {
 	constraints {
 		api libs.logback.classic
 		api libs.caffeine
-		api libs.jsr305
+		api libs.jspecify
 		api libs.protobuf.java
 		api libs.json.path
 		api libs.micrometer.docs.gen

spring-pulsar-reactive/spring-pulsar-reactive.gradle

@@ -27,7 +27,7 @@ dependencies {
 	}
 	implementation 'com.fasterxml.jackson.core:jackson-core'
 	implementation 'com.fasterxml.jackson.core:jackson-databind'
-	implementation libs.jsr305
+	implementation libs.jspecify
 	optional 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8'
 	optional 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
 	optional 'com.fasterxml.jackson.datatype:jackson-datatype-joda'

spring-pulsar-reactive/src/main/java/org/springframework/pulsar/reactive/aot/ReactivePulsarRuntimeHints.java

@@ -33,13 +33,14 @@
 import org.apache.pulsar.shade.io.netty.channel.socket.nio.NioDatagramChannel;
 import org.apache.pulsar.shade.io.netty.channel.socket.nio.NioSocketChannel;
 import org.apache.pulsar.shade.io.netty.util.ReferenceCountUtil;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.aot.hint.MemberCategory;
 import org.springframework.aot.hint.ReflectionHints;
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
 import org.springframework.aot.hint.TypeReference;
-import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
 import org.springframework.util.ReflectionUtils;
 
 /**
@@ -149,7 +150,9 @@ public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader)
 							MemberCategory.INVOKE_PUBLIC_METHODS,
 							MemberCategory.INVOKE_DECLARED_METHODS,
 							MemberCategory.ACCESS_DECLARED_FIELDS)));
-		reflectionHints.registerField(ReflectionUtils.findField(Thread.class, "threadLocalRandomProbe"));
+		var threadLocalRandomProbeField = ReflectionUtils.findField(Thread.class, "threadLocalRandomProbe");
+		Assert.notNull(threadLocalRandomProbeField, "threadLocalRandomProbe not found on Thread.class");
+		reflectionHints.registerField(threadLocalRandomProbeField);
 
 		// @formatter:on
 

spring-pulsar-reactive/src/main/java/org/springframework/pulsar/reactive/aot/package-info.java

@@ -1,9 +1,5 @@
 /**
  * Package containing Reactive AOT runtime hints used by the framework.
  */
-@NonNullApi
-@NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.pulsar.reactive.aot;
-
-import org.springframework.lang.NonNullApi;
-import org.springframework.lang.NonNullFields;