Skip to content

Allow calling close after abort on a ResponseInputStream. #5481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-AWSSDKforJavav2-63a492c.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS SDK for Java v2",
"contributor": "",
"description": "Fixed an issue where invoking `abort` and then `close` on a `ResponseInputStream` would cause the `close` to fail."
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import software.amazon.awssdk.core.io.SdkFilterInputStream;
import software.amazon.awssdk.http.Abortable;
import software.amazon.awssdk.http.AbortableInputStream;
import software.amazon.awssdk.utils.IoUtils;
import software.amazon.awssdk.utils.Validate;

/**
Expand Down Expand Up @@ -57,10 +58,15 @@ public ResponseT response() {
return response;
}

/**
* Close the underlying connection, dropping all remaining data in the stream, and not leaving the
* connection open to be used for future requests.
*/
@Override
public void abort() {
if (abortable != null) {
abortable.abort();
}
IoUtils.closeQuietly(in, null);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will log the potential error at DEBUG level, would we want a higher visibility level for that or no?

Copy link
Contributor Author

@millems millems Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use DEBUG for 1.x as well. In both 1.x and 2.x, it seems to always lead to a "ConnectionClosedException" from Apache, which... yeah, that's what we wanted. I think logging it at a higher level than DEBUG is useful if there's some action that people could perform, but I don't know what we'd want people to do differently.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at the IoUtils that is being used here is https://github.com/aws/aws-sdk-java-v2/blob/master/utils/src/main/java/software/amazon/awssdk/utils/IoUtils.java#L71. This one catches all exceptions instead of catching only IO exceptions. Is that intentional ? I think this might result in an unexpected behavior where we just catch all exceptions and silently log it instead of catching IO exceptions only and if consumers are expecting that behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a reasonable behavior to not fail on non-IO errors as well. This was the behavior in 1.x, and it didn't seem to cause any problem.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, that seemsreasonable . Although I did check SDK1 and its actually only catching IOException on closeQuietly in v1. If its not a problem then its ok to keep this behavior as is

}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.
*/

package software.amazon.awssdk.core;

import static org.assertj.core.api.Assertions.assertThatCode;
import static org.mockito.Mockito.never;

import java.io.IOException;
import java.io.InputStream;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import software.amazon.awssdk.http.Abortable;
import software.amazon.awssdk.http.AbortableInputStream;

class ResponseInputStreamTest {
@Test
void abort_withAbortable_closesUnderlyingStream() throws IOException {
InputStream stream = Mockito.mock(InputStream.class);
Abortable abortable = Mockito.mock(Abortable.class);
AbortableInputStream abortableInputStream = AbortableInputStream.create(stream, abortable);
ResponseInputStream<Object> responseInputStream = new ResponseInputStream<>(new Object(), abortableInputStream);

responseInputStream.abort();

Mockito.verify(abortable).abort();
Mockito.verify(stream).close();
}

@Test
void failedClose_withinAbort_isIgnored() throws IOException {
InputStream stream = Mockito.mock(InputStream.class);
Abortable abortable = Mockito.mock(Abortable.class);
AbortableInputStream abortableInputStream = AbortableInputStream.create(stream, abortable);
ResponseInputStream<Object> responseInputStream = new ResponseInputStream<>(new Object(), abortableInputStream);

Mockito.doThrow(new IOException()).when(stream).close();
assertThatCode(responseInputStream::abort).doesNotThrowAnyException();

Mockito.verify(abortable).abort();
Mockito.verify(stream).close();
}

@Test
void abort_withoutAbortable_closesUnderlyingStream() throws IOException {
InputStream stream = Mockito.mock(InputStream.class);
ResponseInputStream<Object> responseInputStream = new ResponseInputStream<>(new Object(), stream);

responseInputStream.abort();

Mockito.verify(stream).close();
}

@Test
void close_withAbortable_closesUnderlyingStream() throws IOException {
InputStream stream = Mockito.mock(InputStream.class);
Abortable abortable = Mockito.mock(Abortable.class);
AbortableInputStream abortableInputStream = AbortableInputStream.create(stream, abortable);
ResponseInputStream<Object> responseInputStream = new ResponseInputStream<>(new Object(), abortableInputStream);

responseInputStream.close();

Mockito.verify(abortable, never()).abort();
Mockito.verify(stream).close();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package software.amazon.awssdk.services.s3;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static org.junit.Assert.assertEquals;
import static software.amazon.awssdk.testutils.service.S3BucketUtils.temporaryBucketName;

Expand Down Expand Up @@ -123,6 +124,13 @@ public void contentRangeIsReturnedForRangeRequests() {
assertThat(stream.response().contentRange()).isEqualTo("bytes 0-1/10000");
}

@Test
public void sync_closeAfterAbort_doesNotThrowException() {
ResponseInputStream<GetObjectResponse> stream = s3.getObject(getObjectRequest);
stream.abort();
assertThatCode(stream::close).doesNotThrowAnyException();
}

private S3Client createClientWithInterceptor(ExecutionInterceptor interceptor) {
return s3ClientBuilder().overrideConfiguration(ClientOverrideConfiguration.builder()
.addExecutionInterceptor(interceptor)
Expand Down
Loading