-
Notifications
You must be signed in to change notification settings - Fork 21
fix: close getObject response stream for buffering transformers #524
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
Open
sharmabikram
wants to merge
1
commit into
main
Choose a base branch
from
shbikram/getobject-stream-leak
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−2
Open
Changes from all commits
Commits
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
36 changes: 36 additions & 0 deletions
36
src/test/java/software/amazon/encryption/s3/S3EncryptionClientGetObjectStreamCloseTest.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,36 @@ | ||
| // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| package software.amazon.encryption.s3; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import software.amazon.awssdk.core.sync.ResponseTransformer; | ||
| import software.amazon.awssdk.services.s3.model.GetObjectResponse; | ||
|
|
||
| /** | ||
| * Pins the contract that {@link S3EncryptionClient#getObject} relies on to decide whether to close | ||
| * the response stream: buffering transformers do not need the connection left open (so the client | ||
| * closes the stream and avoids the leak), while streaming transformers do (the caller closes it). | ||
| */ | ||
| public class S3EncryptionClientGetObjectStreamCloseTest { | ||
|
|
||
| @Test | ||
| public void bufferingTransformersDoNotNeedConnectionLeftOpen() throws IOException { | ||
| assertFalse(ResponseTransformer.<GetObjectResponse>toBytes().needsConnectionLeftOpen()); | ||
|
|
||
| File tempFile = File.createTempFile("s3ec-close-test", ".tmp"); | ||
| tempFile.delete(); // toFile requires the file to not already exist | ||
| tempFile.deleteOnExit(); | ||
| assertFalse(ResponseTransformer.<GetObjectResponse>toFile(tempFile.toPath()).needsConnectionLeftOpen()); | ||
| } | ||
|
|
||
| @Test | ||
| public void streamingTransformerNeedsConnectionLeftOpen() { | ||
| assertTrue(ResponseTransformer.<GetObjectResponse>toInputStream().needsConnectionLeftOpen()); | ||
| } | ||
| } | ||
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 doesn't actually test the updated getObject method, no? Just properties about the SDK classes themselves? So I don't think this would actually fail without the fix