feat: enhance RateLimitException to return extra information #426
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
MarcGiffing
reviewed
Sep 25, 2025
| private final String configurationName; | ||
|
|
||
| public RateLimitException(Long retryAfterNanoSeconds, Long remainingTokens, String configurationName) { | ||
| super("Rate limit exceeded for configuration: " + configurationName + ". Retry after: " + (retryAfterNanoSeconds != null ? retryAfterNanoSeconds : 0) + "ns. Remaining tokens: " + (remainingTokens != null ? remainingTokens : 0)); |
There was a problem hiding this comment.
I'm not quite sure about it but can the remainingTokens be greater than 0?
Nanoseconds are hard to read. What about milliseconds? Or seconds?
The message line is a little bit to long. my suggestion:
super("Rate limit exceeded for configuration: " + configurationName + ". " +
"Retry after: " + toMilliseconds(retryAfterNanoSeconds) + "ns. " +
"Remaining tokens: " + toMilliseconds(remainingTokens));// the slower variant
super("Rate limit exceeded for configuration %s : . Retry after: %sms . Remaining tokens: %s".formatted(
configurationName,
toMilliseconds(retryAfterNanoSeconds),
toMilliseconds(remainingTokens))
);private static long toMilliseconds(Long retryAfterNanoSeconds) {
return retryAfterNanoSeconds != null ? TimeUnit.NANOSECONDS.toMillis(retryAfterNanoSeconds) : 0;
}
MarcGiffing
reviewed
Sep 25, 2025
| * This exception is thrown when the rate limit is reached in the context of a method level when using the | ||
| * {@link RateLimiting} annotation. | ||
| */ | ||
| public class RateLimitException extends RuntimeException { |
MarcGiffing
reviewed
Sep 25, 2025
| RateLimitException ex1 = assertThrows(RateLimitException.class, () -> testService.withCacheKey("key1")); | ||
| assertTrue(ex1.getRetryAfterNanoSeconds() >= 0); | ||
| assertTrue(ex1.getRemainingTokens() >= 0); | ||
| assertNotNull(ex1.getConfigurationName()); |
There was a problem hiding this comment.
assertEquals("default", ex1.getConfigurationName());
MarcGiffing
reviewed
Sep 25, 2025
| private final long remainingTokens; | ||
| private final String configurationName; | ||
|
|
||
| public RateLimitException(Long retryAfterNanoSeconds, Long remainingTokens, String configurationName) { |
There was a problem hiding this comment.
Isn't the cacheKey also of interest?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently the RateLimitException raises an empty exception. The PR aims to modify the exception to add extra values which can then by the SDK/lib consumers to retreive more information from the given exception and also open up room for better handling of exceptions from Annotation
@RateLimitingException handling improvements:
retryAfterNanoSeconds,remainingTokens, andconfigurationName) and corresponding constructor/getters to theRateLimitExceptionclass to provide more context when a rate limit is exceeded.RateLimitAspectto capture and log the retry time (retryAfterNanoSeconds) when a limit is hit, and to pass this value along with remaining tokens to the result object.