feat: handle retry info so client respect the delay server sets #2026
address comments
- Loading branch information
commit 5f6d5833f2a9e875148d9d635616f5e6fb153d93
There are no files selected for viewing
This file contains 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 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 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,32 @@ | ||
| /* | ||
| * Copyright 2018 Google LLC | ||
| * | ||
| * Licensed 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.google.cloud.bigtable.gaxx.retrying; | ||
|
|
||
| import com.google.api.core.InternalApi; | ||
|
|
||
| // TODO: move this to gax later | ||
| @InternalApi | ||
| public class ApiException { | ||
|
|
||
| // TODO: this should replace the existing ApiException#isRetryable() method, | ||
| // but that cant be done in bigtable, so this lives here for now. | ||
| public static boolean isRetryable2(Throwable e) { | ||
| if (RetryInfoRetryAlgorithm.extractRetryDelay(e) != null) { | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
| } | ||
This file contains 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 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 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,95 @@ | ||
| package com.google.cloud.bigtable.gaxx.retrying; | ||
|
|
||
| import com.google.api.core.InternalApi; | ||
| import com.google.api.gax.retrying.BasicResultRetryAlgorithm; | ||
| import com.google.api.gax.retrying.RetryingContext; | ||
| import com.google.api.gax.retrying.TimedAttemptSettings; | ||
| import com.google.api.gax.rpc.ApiException; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.protobuf.util.Durations; | ||
| import com.google.rpc.RetryInfo; | ||
| import io.grpc.Metadata; | ||
| import io.grpc.Status; | ||
| import io.grpc.protobuf.ProtoUtils; | ||
| import org.threeten.bp.Duration; | ||
|
|
||
| // TODO move this algorithm to gax | ||
| /** | ||
| * This retry algorithm checks the metadata of an exception for additional error details. If the | ||
| * metadata has a RetryInfo field, use the retry delay to set the wait time between attempts. | ||
| */ | ||
| @InternalApi | ||
| public class RetryInfoRetryAlgorithm<ResponseT> extends BasicResultRetryAlgorithm<ResponseT> { | ||
|
|
||
| @VisibleForTesting | ||
| public static final Metadata.Key<RetryInfo> RETRY_INFO_KEY = | ||
| ProtoUtils.keyForProto(RetryInfo.getDefaultInstance()); | ||
|
|
||
| @Override | ||
| public TimedAttemptSettings createNextAttempt( | ||
| Throwable prevThrowable, ResponseT prevResponse, TimedAttemptSettings prevSettings) { | ||
| Duration retryDelay = extractRetryDelay(prevThrowable); | ||
| if (retryDelay != null) { | ||
| return prevSettings | ||
| .toBuilder() | ||
| .setRandomizedRetryDelay(retryDelay) | ||
| .setAttemptCount(prevSettings.getAttemptCount() + 1) | ||
| .build(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** Returns true if previousThrowable is an {@link ApiException} that is retryable. */ | ||
| @Override | ||
| public boolean shouldRetry(Throwable previousThrowable, ResponseT previousResponse) { | ||
| if (extractRetryDelay(previousThrowable) != null) { | ||
| // First check if server wants us to retry | ||
| return true; | ||
| } | ||
| // Server didn't have retry information, use the local status code config. | ||
| return (previousThrowable instanceof ApiException | ||
| && ((ApiException) previousThrowable).isRetryable()); | ||
| } | ||
|
|
||
| /** | ||
| * If {@link RetryingContext#getRetryableCodes()} is not null: Returns true if the status code of | ||
| * previousThrowable is in the list of retryable code of the {@link RetryingContext}. | ||
| * | ||
| * <p>Otherwise it returns the result of {@link #shouldRetry(Throwable, Object)}. | ||
| */ | ||
| @Override | ||
| public boolean shouldRetry( | ||
| RetryingContext context, Throwable previousThrowable, ResponseT previousResponse) { | ||
| if (extractRetryDelay(previousThrowable) != null) { | ||
| // First check if server wants us to retry | ||
| return true; | ||
| } | ||
| if (context.getRetryableCodes() != null) { | ||
| // Ignore the isRetryable() value of the throwable if the RetryingContext has a specific list | ||
| // of codes that should be retried. | ||
| return ((previousThrowable instanceof ApiException) | ||
| && context | ||
| .getRetryableCodes() | ||
| .contains(((ApiException) previousThrowable).getStatusCode().getCode())); | ||
| } | ||
| return shouldRetry(previousThrowable, previousResponse); | ||
| } | ||
|
|
||
| static Duration extractRetryDelay(Throwable throwable) { | ||
mutianf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (throwable == null) { | ||
| return null; | ||
| } | ||
| Metadata trailers = Status.trailersFromThrowable(throwable); | ||
| if (trailers == null) { | ||
| return null; | ||
| } | ||
| RetryInfo retryInfo = trailers.get(RETRY_INFO_KEY); | ||
| if (retryInfo == null) { | ||
| return null; | ||
| } | ||
| if (!retryInfo.hasRetryDelay()) { | ||
| return null; | ||
| } | ||
| return Duration.ofMillis(Durations.toMillis(retryInfo.getRetryDelay())); | ||
| } | ||
| } | ||
This file contains 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
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.
This should be ApiExceptions. Also please add a private ctor
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.
In gax it is ApiException I think https://github.com/googleapis/sdk-platform-java/blob/main/gax-java/gax/src/main/java/com/google/api/gax/rpc/ApiException.java
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.
In general the pattern is that the instance class is singular and the helper utility with static methods is plural.
In this case you are adding latter. Eventually when you upstream, you will make it an instance method and it will be in ApiException. But in the transitional state I think plural makes sense