-
Notifications
You must be signed in to change notification settings - Fork 915
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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." | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
core/sdk-core/src/test/java/software/amazon/awssdk/core/ResponseInputStreamTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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(); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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