jspecify integration on s3 module

andreacioni · andreacioni · commit d0a428b109d7 · 2025-12-14T09:11:13.000+01:00
Signed-off-by: Andrea Cioni &lt;supercionci@hotmail.it&gt;
diff --git a/spring-batch-s3/pom.xml b/spring-batch-s3/pom.xml
@@ -72,6 +72,12 @@
         <type>pom</type>
         <version>${aws.java.sdk.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.jspecify</groupId>
+        <artifactId>jspecify</artifactId>
+        <version>0.3.0</version>
+        <scope>provided</scope>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
@@ -94,6 +100,11 @@
       <artifactId>spring-batch-core</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.jspecify</groupId>
+      <artifactId>jspecify</artifactId>
+    </dependency>
+
     <!-- Test -->
     <dependency>
       <groupId>org.assertj</groupId>
@@ -124,8 +135,31 @@
         <artifactId>maven-compiler-plugin</artifactId>
         <configuration>
           <compilerArgs>
-            <arg>-Xlint:all,deprecation</arg>
+            <compilerArg>-Xlint:all,-varargs</compilerArg>
+            <!-- https://errorprone.info/docs/installation#maven -->
+            <compilerArg>-XDcompilePolicy=simple</compilerArg>
+            <compilerArg>--should-stop=ifError=FLOW</compilerArg>
+            <compilerArg>
+              -Xplugin:ErrorProne
+              -XepDisableAllChecks
+              <!-- Check JSpecify annotations -->
+              -Xep:NullAway
+              -XepOpt:NullAway:OnlyNullMarked
+              -XepOpt:NullAway:SuppressionNameAliases=DataFlowIssue
+            </compilerArg>
           </compilerArgs>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>com.google.errorprone</groupId>
+              <artifactId>error_prone_core</artifactId>
+              <version>2.43.0</version>
+            </path>
+            <path>
+              <groupId>com.uber.nullaway</groupId>
+              <artifactId>nullaway</artifactId>
+              <version>0.12.11</version>
+            </path>
+          </annotationProcessorPaths>
         </configuration>
       </plugin>
       <plugin>
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/S3ItemReader.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/S3ItemReader.java
@@ -19,6 +19,8 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.batch.extensions.s3.serializer.S3Deserializer;
 import org.springframework.batch.extensions.s3.stream.S3InputStream;
 import org.springframework.batch.infrastructure.item.ItemReader;
@@ -49,6 +51,7 @@ public S3ItemReader(S3InputStream in, S3Deserializer<T> deserializer) {
 	}
 
 	@Override
+	@Nullable
 	public T read() throws Exception {
 		T item;
 
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/S3ItemReaderBuilder.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/S3ItemReaderBuilder.java
@@ -16,21 +16,27 @@
 
 package org.springframework.batch.extensions.s3.builder;
 
+import org.jspecify.annotations.Nullable;
 import software.amazon.awssdk.services.s3.S3Client;
 
 import org.springframework.batch.extensions.s3.S3ItemReader;
 import org.springframework.batch.extensions.s3.serializer.S3Deserializer;
 import org.springframework.batch.extensions.s3.stream.S3InputStream;
 
 public class S3ItemReaderBuilder<T> {
+	@Nullable
 	private S3Client s3Client;
 
+	@Nullable
 	private String bucketName;
 
+	@Nullable
 	private String objectKey;
 
+	@Nullable
 	private S3Deserializer<T> deserializer;
 
+	@Nullable
 	private Integer bufferSize;
 
 	public S3ItemReaderBuilder<T> s3Client(S3Client s3Client) {
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/S3ItemWriterBuilder.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/S3ItemWriterBuilder.java
@@ -19,6 +19,7 @@
 import java.io.IOException;
 import java.io.OutputStream;
 
+import org.jspecify.annotations.Nullable;
 import software.amazon.awssdk.services.s3.S3Client;
 
 import org.springframework.batch.extensions.s3.S3ItemWriter;
@@ -28,18 +29,24 @@
 import org.springframework.batch.extensions.s3.stream.S3OutputStream;
 
 public class S3ItemWriterBuilder<T> {
+	@Nullable
 	private S3Client s3Client;
 
+	@Nullable
 	private String bucket;
 
+	@Nullable
 	private String key;
 
+	@Nullable
 	private S3Serializer<T> serializer;
 
 	private boolean multipartUpload;
 
+	@Nullable
 	private String contentType;
 
+	@Nullable
 	private Integer partSize;
 
 	public S3ItemWriterBuilder<T>  s3Client(S3Client s3Client) {
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/package-info.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/builder/package-info.java
@@ -24,5 +24,7 @@
  * convenient way to read large datasets stored in S3 without loading them entirely into
  * memory.
  */
-
+@NullMarked
 package org.springframework.batch.extensions.s3.builder;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/package-info.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/package-info.java
@@ -25,4 +25,7 @@
  * memory.
  */
 
+@NullMarked
 package org.springframework.batch.extensions.s3;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/S3Deserializer.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/S3Deserializer.java
@@ -16,6 +16,8 @@
 
 package org.springframework.batch.extensions.s3.serializer;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * A functional interface for serializing items to byte arrays for S3 storage.
  * Implementations should provide a way to convert an item of type T into a byte array.
@@ -34,6 +36,7 @@ public interface S3Deserializer<T> {
 	 * @param buffer the byte array to deserialize
 	 * @return the deserialized object
 	 */
+	@Nullable
 	T deserialize(byte[] buffer);
 
 }
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/S3StringDeserializer.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/S3StringDeserializer.java
@@ -19,6 +19,8 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Simple deserializer for String items from S3. It reads lines from a byte array,
  * handling both \n and \r\n line endings.
@@ -41,6 +43,7 @@ public S3StringDeserializer(Charset charset) {
 	}
 
 	@Override
+	@Nullable
 	public String deserialize(byte[] buffer) {
 		String incoming = new String(buffer, this.charset);
 		this.stringBuilder.append(incoming);
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/package-info.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/serializer/package-info.java
@@ -24,4 +24,7 @@
  * convenient way to read large datasets stored in S3 without loading them entirely into
  * memory.
  */
+@NullMarked
 package org.springframework.batch.extensions.s3.serializer;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3InputStream.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3InputStream.java
@@ -19,6 +19,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.services.s3.S3Client;
@@ -41,6 +42,7 @@ public class S3InputStream extends InputStream {
 
 	private final String objectKey;
 
+	@Nullable
 	private InputStream inputStream;
 
 	public S3InputStream(S3Client s3, String bucketName, String objectKey) {
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3MultipartOutputStream.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3MultipartOutputStream.java
@@ -24,6 +24,7 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.services.s3.S3Client;
@@ -44,7 +45,8 @@ public class S3MultipartOutputStream extends OutputStream {
 
 	private final PipedOutputStream pipedOutputStream;
 
-	private  ExecutorService singleThreadExecutor;
+	@Nullable
+	private ExecutorService singleThreadExecutor;
 
 	private volatile boolean uploading;
 
@@ -104,7 +106,7 @@ public void close() throws IOException {
 
 		if (this.uploading) {
 			try {
-				if (!this.singleThreadExecutor.awaitTermination(10L, TimeUnit.SECONDS)) {
+				if (this.singleThreadExecutor != null && !this.singleThreadExecutor.awaitTermination(10L, TimeUnit.SECONDS)) {
 					logger.warn("Multipart upload thread did not finish in time");
 				}
 			}
@@ -117,7 +119,7 @@ public void close() throws IOException {
 		super.close();
 	}
 
-	public void setSingleThreadExecutor(ExecutorService singleThreadExecutor) {
+	public void setSingleThreadExecutor(@Nullable ExecutorService singleThreadExecutor) {
 		this.singleThreadExecutor = singleThreadExecutor;
 	}
 }
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3OutputStream.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/S3OutputStream.java
@@ -23,6 +23,7 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.core.sync.RequestBody;
@@ -54,6 +55,7 @@ public class S3OutputStream extends OutputStream {
 
 	private final PipedOutputStream pipedOutputStream;
 
+	@Nullable
 	private ExecutorService singleThreadExecutor;
 
 	private volatile boolean uploading;
diff --git a/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/package-info.java b/spring-batch-s3/src/main/java/org/springframework/batch/extensions/s3/stream/package-info.java
@@ -24,4 +24,7 @@
  * convenient way to read large datasets stored in S3 without loading them entirely into
  * memory.
  */
+@NullMarked
 package org.springframework.batch.extensions.s3.stream;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-s3/src/test/java/org/springframework/batch/extensions/s3/package-info.java b/spring-batch-s3/src/test/java/org/springframework/batch/extensions/s3/package-info.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides support for reading items from Amazon S3 using a stream-based approach. This
+ * package includes classes for reading items from S3 objects, deserializing them, and
+ * handling the input stream efficiently.
+ *
+ * <p>
+ * Classes in this package are designed to work with the AWS SDK for Java and provide a
+ * convenient way to read large datasets stored in S3 without loading them entirely into
+ * memory.
+ */
+@NullMarked
+package org.springframework.batch.extensions.s3;
+
+import org.jspecify.annotations.NullMarked;
+
+
diff --git a/spring-batch-s3/src/test/java/org/springframework/batch/extensions/s3/serializer/package-info.java b/spring-batch-s3/src/test/java/org/springframework/batch/extensions/s3/serializer/package-info.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides support for reading items from Amazon S3 using a stream-based approach. This
+ * package includes classes for reading items from S3 objects, deserializing them, and
+ * handling the input stream efficiently.
+ *
+ * <p>
+ * Classes in this package are designed to work with the AWS SDK for Java and provide a
+ * convenient way to read large datasets stored in S3 without loading them entirely into
+ * memory.
+ */
+@NullMarked
+package org.springframework.batch.extensions.s3.serializer;
+
+import org.jspecify.annotations.NullMarked;
+
+
