This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
feat: support retry settings and retryable codes in call context #1238
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,14 +30,17 @@ | |
| package com.google.api.gax.grpc; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.gax.retrying.RetrySettings; | ||
| import com.google.api.gax.rpc.ApiCallContext; | ||
| import com.google.api.gax.rpc.StatusCode; | ||
| import com.google.api.gax.rpc.TransportChannel; | ||
| import com.google.api.gax.rpc.internal.Headers; | ||
| import com.google.api.gax.tracing.ApiTracer; | ||
| import com.google.api.gax.tracing.NoopApiTracer; | ||
| import com.google.auth.Credentials; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import io.grpc.CallCredentials; | ||
| import io.grpc.CallOptions; | ||
| import io.grpc.CallOptions.Key; | ||
|
|
@@ -48,6 +51,7 @@ | |
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import org.threeten.bp.Duration; | ||
|
|
@@ -70,18 +74,36 @@ public final class GrpcCallContext implements ApiCallContext { | |
| @Nullable private final Duration streamWaitTimeout; | ||
| @Nullable private final Duration streamIdleTimeout; | ||
| @Nullable private final Integer channelAffinity; | ||
| @Nullable private final RetrySettings retrySettings; | ||
| @Nullable private final ImmutableSet<StatusCode.Code> retryableCodes; | ||
| private final ImmutableMap<String, List<String>> extraHeaders; | ||
|
|
||
| /** Returns an empty instance with a null channel and default {@link CallOptions}. */ | ||
| public static GrpcCallContext createDefault() { | ||
| return new GrpcCallContext( | ||
| null, | ||
| CallOptions.DEFAULT, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| ImmutableMap.<String, List<String>>of(), | ||
| null, | ||
| null); | ||
| } | ||
|
|
||
| /** Returns an instance with the given channel and {@link CallOptions}. */ | ||
| public static GrpcCallContext of(Channel channel, CallOptions callOptions) { | ||
| return new GrpcCallContext( | ||
| channel, | ||
| callOptions, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| ImmutableMap.<String, List<String>>of(), | ||
| null, | ||
| null); | ||
| } | ||
|
|
||
| private GrpcCallContext( | ||
|
|
@@ -91,14 +113,18 @@ private GrpcCallContext( | |
| @Nullable Duration streamWaitTimeout, | ||
| @Nullable Duration streamIdleTimeout, | ||
| @Nullable Integer channelAffinity, | ||
| ImmutableMap<String, List<String>> extraHeaders, | ||
| @Nullable RetrySettings retrySettings, | ||
| @Nullable Set<StatusCode.Code> retryableCodes) { | ||
| this.channel = channel; | ||
| this.callOptions = Preconditions.checkNotNull(callOptions); | ||
| this.timeout = timeout; | ||
| this.streamWaitTimeout = streamWaitTimeout; | ||
| this.streamIdleTimeout = streamIdleTimeout; | ||
| this.channelAffinity = channelAffinity; | ||
| this.extraHeaders = Preconditions.checkNotNull(extraHeaders); | ||
| this.retrySettings = retrySettings; | ||
| this.retryableCodes = retryableCodes == null ? null : ImmutableSet.copyOf(retryableCodes); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -160,7 +186,9 @@ public GrpcCallContext withTimeout(@Nullable Duration timeout) { | |
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @Nullable | ||
|
|
@@ -177,13 +205,15 @@ public GrpcCallContext withStreamWaitTimeout(@Nullable Duration streamWaitTimeou | |
| } | ||
|
|
||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -194,25 +224,29 @@ public GrpcCallContext withStreamIdleTimeout(@Nullable Duration streamIdleTimeou | |
| } | ||
|
|
||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @BetaApi("The surface for channel affinity is not stable yet and may change in the future.") | ||
| public GrpcCallContext withChannelAffinity(@Nullable Integer affinity) { | ||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| affinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @BetaApi("The surface for extra headers is not stable yet and may change in the future.") | ||
|
|
@@ -222,13 +256,53 @@ public GrpcCallContext withExtraHeaders(Map<String, List<String>> extraHeaders) | |
| ImmutableMap<String, List<String>> newExtraHeaders = | ||
| Headers.mergeHeaders(this.extraHeaders, extraHeaders); | ||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| newExtraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @Override | ||
| public RetrySettings getRetrySettings() { | ||
| return this.retrySettings; | ||
| } | ||
|
|
||
| @Override | ||
|
There was a problem hiding this comment. What is the difference between the retry settings here, and those in UnaryCallSettings? There was a problem hiding this comment.
There was a problem hiding this comment. Furthermore, |
||
| public GrpcCallContext withRetrySettings(RetrySettings retrySettings) { | ||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<StatusCode.Code> getRetryableCodes() { | ||
| return this.retryableCodes; | ||
| } | ||
|
|
||
| @Override | ||
| public GrpcCallContext withRetryableCodes(Set<StatusCode.Code> retryableCodes) { | ||
| return new GrpcCallContext( | ||
| this.channel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| retryableCodes); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -283,8 +357,18 @@ public ApiCallContext merge(ApiCallContext inputCallContext) { | |
| newChannelAffinity = this.channelAffinity; | ||
| } | ||
|
|
||
| RetrySettings newRetrySettings = grpcCallContext.retrySettings; | ||
| if (newRetrySettings == null) { | ||
| newRetrySettings = this.retrySettings; | ||
| } | ||
|
|
||
| Set<StatusCode.Code> newRetryableCodes = grpcCallContext.retryableCodes; | ||
| if (newRetryableCodes == null) { | ||
| newRetryableCodes = this.retryableCodes; | ||
| } | ||
|
|
||
| ImmutableMap<String, List<String>> newExtraHeaders = | ||
| Headers.mergeHeaders(this.extraHeaders, grpcCallContext.extraHeaders); | ||
|
|
||
| CallOptions newCallOptions = | ||
| grpcCallContext | ||
|
|
@@ -303,7 +387,9 @@ public ApiCallContext merge(ApiCallContext inputCallContext) { | |
| newStreamWaitTimeout, | ||
| newStreamIdleTimeout, | ||
| newChannelAffinity, | ||
| newExtraHeaders, | ||
| newRetrySettings, | ||
| newRetryableCodes); | ||
| } | ||
|
|
||
| /** The {@link Channel} set on this context. */ | ||
|
|
@@ -357,23 +443,27 @@ public GrpcCallContext withChannel(Channel newChannel) { | |
| return new GrpcCallContext( | ||
| newChannel, | ||
| this.callOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| /** Returns a new instance with the call options set to the given call options. */ | ||
| public GrpcCallContext withCallOptions(CallOptions newCallOptions) { | ||
| return new GrpcCallContext( | ||
| this.channel, | ||
| newCallOptions, | ||
| this.timeout, | ||
| this.streamWaitTimeout, | ||
| this.streamIdleTimeout, | ||
| this.channelAffinity, | ||
| this.extraHeaders, | ||
| this.retrySettings, | ||
| this.retryableCodes); | ||
| } | ||
|
|
||
| public GrpcCallContext withRequestParamsDynamicHeaderOption(String requestParams) { | ||
|
|
@@ -410,7 +500,9 @@ public int hashCode() { | |
| streamWaitTimeout, | ||
| streamIdleTimeout, | ||
| channelAffinity, | ||
| extraHeaders, | ||
| retrySettings, | ||
| retryableCodes); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -423,13 +515,15 @@ public boolean equals(Object o) { | |
| } | ||
|
|
||
| GrpcCallContext that = (GrpcCallContext) o; | ||
| return Objects.equals(this.channel, that.channel) | ||
| && Objects.equals(this.callOptions, that.callOptions) | ||
| && Objects.equals(this.timeout, that.timeout) | ||
| && Objects.equals(this.streamWaitTimeout, that.streamWaitTimeout) | ||
| && Objects.equals(this.streamIdleTimeout, that.streamIdleTimeout) | ||
| && Objects.equals(this.channelAffinity, that.channelAffinity) | ||
| && Objects.equals(this.extraHeaders, that.extraHeaders) | ||
| && Objects.equals(this.retrySettings, that.retrySettings) | ||
| && Objects.equals(this.retryableCodes, that.retryableCodes); | ||
| } | ||
|
|
||
| Metadata getMetadata() { | ||
|
|
||
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.
Why is this nullable? per Effective Java, empty collections are preferred.
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.
There is a difference in this case:
nullmeans 'do not override the default settings`.I've added that to the documentation of
ApiCallContext#getRetryableCodes().