Clarification regarding correct usage of ResponseInputStream#abort and #close

[pepijnve]

Describe the issue

Using a ReponseInputStream in a try-with-resources block combined with a call to abort can lead to a 'premature end of stream' error.

As an example, the following code

s3Client.putObject(b -> b.bucket(bucketName).key("object"), RequestBody.fromString("abcd"));
try (var object = s3Client.getObject(GetObjectRequest.builder().bucket(bucketName).key("object").build())) {
   object.abort();
}

produces an exception with this stack trace

org.apache.http.ConnectionClosedException: Premature end of Content-Length delimited message body (expected: 4; received: 0)
at org.apache.http.impl.io.ContentLengthInputStream.read(ContentLengthInputStream.java:178)
at org.apache.http.impl.io.ContentLengthInputStream.read(ContentLengthInputStream.java:198)
at org.apache.http.impl.io.ContentLengthInputStream.close(ContentLengthInputStream.java:101)
at org.apache.http.impl.execchain.ResponseEntityProxy.streamClosed(ResponseEntityProxy.java:142)
at org.apache.http.conn.EofSensorInputStream.checkClose(EofSensorInputStream.java:228)
at org.apache.http.conn.EofSensorInputStream.close(EofSensorInputStream.java:172)
at java.base/java.io.FilterInputStream.close(FilterInputStream.java:170)
at java.base/java.io.FilterInputStream.close(FilterInputStream.java:170)
at software.amazon.awssdk.core.io.SdkFilterInputStream.close(SdkFilterInputStream.java:83)

Is this the expected behaviour? The javadoc for ReponseInputStream seems to suggest that abort should be used instead of close. That does make it rather difficult to use abort in combination with try-with-resources.

Links

https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/core/ResponseInputStream.html

[bhoradc]

Hi @pepijnve,

Thanks for reporting the issue. What is the Java SDK version you are using? I believe if its lower than v2.27.2, you would encounter this issue.

This bug was fixed in v2.27.2, can you kindly upgrade to the latest available SDK version and valid this behavior?

I used below code snippet to confirm that ResponseInputStream#abort works as expected on Java SDK version v2.27.2 and above.

package org.example;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;

public class Main {
	public static void main(String[] args) {
		S3Client s3Client = S3Client.builder()
				.region(Region.US_EAST_1)
				.build();
		String bucketName = "bucket_name";
		String key = "test-object";
		try {
			s3Client.putObject(builder -> builder
							.bucket(bucketName)
							.key(key),
					RequestBody.fromString("abcd"));
			try (var response = s3Client.getObject(GetObjectRequest.builder()
					.bucket(bucketName)
					.key(key)
					.build())) {
				response.abort();
			}
		} catch (Exception e) {
			System.out.println("Exception occurred: " + e.getMessage());
			e.printStackTrace();
		} finally {
			s3Client.close();
		}
	}
}

Regards,
Chaitanya

[pepijnve]

@bhoradc thanks for the feedback. Our project was still on 2.18.12 when we bumped into the issue. Updated to something much more recent in the meantime, so we can probably remove the workaround we put in place.

[bhoradc]

Hi @pepijnve,

Thanks for the confirmation, I will therefore close the issue.

Regards,
Chaitanya

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.