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
Add ADAPTIVE_V2 retry mode to support the legacy behavior #5123
Add ADAPTIVE_V2 retry mode to support the legacy behavior #5123
Conversation
Quality Gate passedIssues Measures |
* from remembering its state across requests which is needed to correctly estimate its sending rate. Given that the | ||
* this bug has been present since its introduction and that correct version might change the traffic patterns of the SDK we |
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.
"Given that the"
* @deprecated As of 2.25.xx, replaced by {@link #ADAPTIVE_V2}. The ADAPTIVE implementation has a bug that prevents it | ||
* from remembering its state across requests which is needed to correctly estimate its sending rate. Given that the | ||
* this bug has been present since its introduction and that correct version might change the traffic patterns of the SDK we | ||
* deemed too risky to fix this implementation.. |
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.
repeated period
* Adaptive V2 mode differs from {@link #ADAPTIVE} mode in the computed delays between calls, including the fist attempt | ||
* that might be delayed if the algorithm considers that it's needed to increase the odds of a successful response. The | ||
* previous Adaptive mode is also designed to work like so but a bug present since its introduction prevents it from | ||
* preserving its internal state across requests. | ||
* <p> |
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.
s/fist/first/
Also should "Adaptive" be capitalized?
The
* previous Adaptive mode is also designed to work like so but a bug present since its introduction prevents it from
* preserving its internal state across requests.
I don't think it's necessary to specify that ADAPTIVE
is also supposed to work this. If we link back to ADAPTIVE
from here I think that's sufficient
if (retryMode == RetryMode.ADAPTIVE_V2) { | ||
throw new UnsupportedOperationException("ADAPTIVE_V2 is not supported by retry policies, use a RetryStrategy " | ||
+ "instead"); | ||
} |
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.
Can we move this check to Builder
instead?
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 moved this to the builder, not sure what's the reason behind it but I guess it's the same.
Motivation and Context
This change is aimed to prevent breaking existing users of the legacy adaptive mode while introducing the means needed for new users to onboard and use the correct adaptive implementation.
Modifications
This change introduces a new
RetryMode
constant,ADAPTIVE_V2
and uses the legacyADAPTIVE
retry policy by adapting it to a retry strategy using the existing adapter when theADAPTIVE
mode is requested, either by usingAwsRetryStrategy.forRetryMode(RetryMode.ADAPTIVE)
call, or by setting theretry_mode=adaptive
value in the profile file or by using theaws.retryMode=ADAPTIVE
system setting.Customers that need or want the correct adaptive mode will need to use instead
RetryMode.ADAPTIVE_V2
. This will reduce the risk of breaking customers that are using the legacy mode.Testing
Added unit tests to validate that all the current ways of configuring the retry logic in the SDK will create the expected and correct instance that implements the desired logic.
Screenshots (if appropriate)
Types of changes
Checklist
mvn install
succeedsscripts/new-change
script and following the instructions. Commit the new file created by the script in.changes/next-release
with your changes.License