spring/spring-framework
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-framework.git synced 2026-10-03 05:19:07 +00:00
Code Issues Projects Releases Wiki Activity

Improve error message for preemptive timeout in RetryTemplate

Browse Source 
The error message in such cases now indicates that the retry process
is being aborted preemptively due to pending sleep time.

For example:

  Retry policy for operation 'myMethod' would exceed timeout (5 ms) due
  to pending sleep time (10 ms); preemptively aborting execution

See gh-35963
This commit is contained in:
Sam Brannen
2025-12-09 16:46:44 +01:00
parent 2643c6212f
commit 61201db704
2 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
spring-core/src/main/java/org/springframework/core/retry/RetryTemplate.java
+6 -2
View File
@@ -213,9 +213,13 @@ public class RetryTemplate implements RetryOperations {
// would be if we were to sleep for sleepTime milliseconds.
long elapsedTime = System.currentTimeMillis() + sleepTime - startTime;
if (elapsedTime >= timeout) {
RetryException retryException = new RetryException(
String message = (sleepTime > 0 ? """
Retry policy for operation '%s' would exceed timeout (%d ms) due \
to pending sleep time (%d ms); preemptively aborting execution"""
.formatted(retryable.getName(), timeout, sleepTime) :
"Retry policy for operation '%s' exceeded timeout (%d ms); aborting execution"
.formatted(retryable.getName(), timeout), exceptions.removeLast());
.formatted(retryable.getName(), timeout));
RetryException retryException = new RetryException(message, exceptions.removeLast());
exceptions.forEach(retryException::addSuppressed);
this.retryListener.onRetryPolicyTimeout(this.retryPolicy, retryable, retryException);
throw retryException;
spring-core/src/test/java/org/springframework/core/retry/RetryTemplateTests.java
+4 -1
View File
@@ -502,7 +502,10 @@ class RetryTemplateTests {
assertThat(invocationCount).hasValue(0);
assertThatExceptionOfType(RetryException.class)
.isThrownBy(() -> retryTemplate.execute(retryable))
.withMessageMatching("Retry policy for operation '.+?' exceeded timeout \\(5 ms\\); aborting execution")
.withMessageMatching("""
Retry policy for operation '.+?' would exceed timeout \\(5 ms\\) \
due to pending sleep time \\(10 ms\\); preemptively aborting execution\
""")
.withCause(new CustomException("Boom 1"))
.satisfies(throwable -> inOrder.verify(retryListener).onRetryPolicyTimeout(
eq(retryPolicy), eq(retryable), eq(throwable)));