Fix potentially flaky S3TransferManagerListenerTests #2801
Merged
Conversation
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
As they were previously written, these tests were subject to fail due to the following reasons: 1. The execution order of multiple `CompletableFuture#whenComplete(..)` calls is non-deterministic (unless the result of each one is chained together, in sequence) 2. Therefore it was possible that the `CompletableFuture` associated with a transfer may be completed before or after `TransferListener#transferComplete(..)` was invoked 3. While this is not problematic from a public API perspective, our tests assumed that the future completion meant all listeners had been exercised, which may not always be true This change fixes the tests to instead await for the expected interactions to occur, rather than await for the associated future to be completed. An alternative approach would be to sequence the multiple completion stages together, guaranteeing that listeners are invoked before the future is completed, but this may delay the completion of the future in the event of longer-running listener implementations. It seems preferable to favor immediate completion of the future.
|
SonarCloud Quality Gate failed. |
joviegas
reviewed
Oct 28, 2021
...src/test/java/software/amazon/awssdk/transfer/s3/internal/S3TransferManagerListenerTest.java
Show resolved
Hide resolved
As they were previously written, these tests were subject to fail due to the following reasons: 1. The execution order of multiple `CompletableFuture#whenComplete(..)` calls is non-deterministic (unless the result of each one is chained together, in sequence) 2. Therefore it was possible that the `CompletableFuture` associated with a transfer may be completed before or after `TransferListener#transferComplete(..)` was invoked 3. While this is not problematic from a public API perspective, our tests assumed that the future completion meant all listeners had been exercised, which may not always be true This change fixes the tests to instead await for the expected interactions to occur, rather than await for the associated future to be completed. An alternative approach would be to sequence the multiple completion stages together, guaranteeing that listeners are invoked before the future is completed, but this may delay the completion of the future in the event of longer-running listener implementations. It seems preferable to favor immediate completion of the future.
joviegas
approved these changes
Oct 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As they were previously written, these tests were subject to fail due to
the following reasons:
CompletableFuture#whenComplete(..)calls is non-deterministic (unless the result of each one is chained
together, in sequence)
CompletableFutureassociatedwith a transfer may be completed before or after
TransferListener#transferComplete(..)was invokedtests assumed that the future completion meant all listeners had been
exercised, which may not always be true
This change fixes the tests to instead await for the expected
interactions to occur, rather than await for the associated future to be
completed.
An alternative approach would be to sequence the multiple completion
stages together, guaranteeing that listeners are invoked before the
future is completed, but this may delay the completion of the future in
the event of longer-running listener implementations. It seems
preferable to favor immediate completion of the future.
License