Add retry limiter support #6318
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
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
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
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,100 @@ | ||
| /* | ||
| * Copyright 2025 LY Corporation | ||
| * | ||
| * LY Corporation licenses this file to you under the Apache License, | ||
| * version 2.0 (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at: | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package com.linecorp.armeria.client.retry; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.linecorp.armeria.client.ClientRequestContext; | ||
| import com.linecorp.armeria.client.retry.limiter.RetryLimiter; | ||
| import com.linecorp.armeria.common.annotation.Nullable; | ||
| import com.linecorp.armeria.common.logging.RequestLog; | ||
|
|
||
| /** | ||
| * Executes {@link RetryLimiter} operations with proper exception handling. | ||
| * <p> | ||
| * This class provides static utility methods to safely execute retry limiter operations. | ||
| * It handles null limiters gracefully and catches any exceptions thrown by the limiter | ||
| * to prevent them from affecting the retry logic. | ||
| * </p> | ||
| * <p> | ||
| * When a limiter throws an exception, it is logged as an error and the operation | ||
| * defaults to allowing the retry to proceed (returning {@code true} for {@link #shouldRetry} | ||
| * and doing nothing for {@link #onCompletedAttempt}). | ||
| * </p> | ||
| */ | ||
| final class RetryLimiterExecutor { | ||
|
|
||
| private RetryLimiterExecutor() {} | ||
|
|
||
| private static final Logger logger = LoggerFactory.getLogger(RetryLimiterExecutor.class); | ||
|
|
||
| /** | ||
| * Determines whether a retry should be attempted based on the provided limiter. | ||
| * <p> | ||
| * This method safely executes the limiter's {@link RetryLimiter#shouldRetry} method. | ||
| * If the limiter is null, this method returns {@code true} to allow retries. | ||
| * If the limiter throws an exception, it is logged and {@code true} is returned | ||
| * to ensure retries can still proceed. | ||
| * </p> | ||
| * | ||
| * @param limiter the retry limiter to consult, or {@code null} if no limiter is configured | ||
| * @param ctx the client request context | ||
| * @param numAttemptsSoFar the number of attempts made so far (0-based) | ||
| * @return {@code true} if a retry should be attempted, {@code false} otherwise. | ||
| * Returns {@code true} if the limiter is null or throws an exception. | ||
| */ | ||
| public static boolean shouldRetry(@Nullable RetryLimiter limiter, ClientRequestContext ctx, | ||
| int numAttemptsSoFar) { | ||
| try { | ||
| if (limiter != null) { | ||
| return limiter.shouldRetry(ctx, numAttemptsSoFar); | ||
| } else { | ||
| return true; | ||
| } | ||
| } catch (Throwable t) { | ||
| logger.error("Failed to execute RetryLimiter.shouldRetry: limiter={}, attempts={}", limiter, | ||
| numAttemptsSoFar, t); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Notifies the limiter that an attempt has been completed. | ||
| * <p> | ||
| * This method safely executes the limiter's {@link RetryLimiter#onCompletedAttempt} method. | ||
| * If the limiter is null, this method does nothing. | ||
| * If the limiter throws an exception, it is logged but does not affect the retry flow. | ||
| * </p> | ||
| * | ||
| * @param limiter the retry limiter to notify, or {@code null} if no limiter is configured | ||
| * @param ctx the client request context | ||
| * @param requestLog the request log containing details about the completed attempt | ||
| * @param numAttemptsSoFar the number of attempts made so far (0-based) | ||
| */ | ||
| public static void onCompletedAttempt(@Nullable RetryLimiter limiter, ClientRequestContext ctx, | ||
| RequestLog requestLog, int numAttemptsSoFar) { | ||
| try { | ||
| if (limiter != null) { | ||
| limiter.onCompletedAttempt(ctx, requestLog, numAttemptsSoFar); | ||
| } | ||
| } catch (Throwable t) { | ||
| logger.error("Failed to execute RetryLimiter.onCompletedAttempt: limiter={}, attempts={}", limiter, | ||
| numAttemptsSoFar, t); | ||
| } | ||
| } | ||
| } |
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
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
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.
Note:
AbstractRetryingClientis public so this and the change above are breaking changes. Let us note it in the PR description.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.
But these are protected methods, do they also count as public api?
Uh oh!
There was an error while loading. Please reload this page.
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.
As this class is also not final people could inherit from it and use those methods. I cannot think of a use-case for it but theoretically it is possible. In the doc comments we are also not advising against it 🤷