Skip to content

feat(gax): Implement cert-rotation retries for grpc and http-json. #13246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vverman wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(gax): Implement cert-rotation retries for grpc and http-json. #13246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/ChannelPool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ class ChannelPool extends ManagedChannel {
private ScheduledFuture<?> resizeFuture = null;

private final Object entryWriteLock = new Object();
private long lastRefreshTimeNanos = 0;
@VisibleForTesting final AtomicReference<ImmutableList<Entry>> entries = new AtomicReference<>();
private final AtomicInteger indexTicker = new AtomicInteger();
private final String authority;
Expand Down Expand Up @@ -441,6 +442,13 @@ void refresh() {
// - then thread2 will shut down channel that thread1 will put back into circulation (after it
// replaces the list)
synchronized (entryWriteLock) {
long now = System.nanoTime();
if (now - lastRefreshTimeNanos < TimeUnit.SECONDS.toNanos(5)) {
LOG.fine("Channel pool was refreshed recently, skipping duplicate refresh");
return;
}
lastRefreshTimeNanos = now;

LOG.fine("Refreshing all channels");
ArrayList<Entry> newEntries = new ArrayList<>(entries.get());

Expand Down
58 changes: 41 additions & 17 deletions ...latform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcCallContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ public final class GrpcCallContext implements ApiCallContext {
private final ApiCallContextOptions options;
private final EndpointContext endpointContext;
private final boolean isDirectPath;
@Nullable private final TransportChannel transportChannel;

/** Returns an empty instance with a null channel and default {@link CallOptions}. */
public static GrpcCallContext createDefault() {
Expand All @@ -113,7 +114,8 @@ public static GrpcCallContext createDefault() {
null,
null,
null,
false);
false,
null);
}

/** Returns an instance with the given channel and {@link CallOptions}. */
Expand All @@ -131,7 +133,8 @@ public static GrpcCallContext of(Channel channel, CallOptions callOptions) {
null,
null,
null,
false);
false,
null);
}

private GrpcCallContext(
Expand All @@ -147,7 +150,8 @@ private GrpcCallContext(
@Nullable RetrySettings retrySettings,
@Nullable Set<StatusCode.Code> retryableCodes,
@Nullable EndpointContext endpointContext,
boolean isDirectPath) {
boolean isDirectPath,
@Nullable TransportChannel transportChannel) {
this.channel = channel;
this.credentials = credentials;
Preconditions.checkNotNull(callOptions);
Expand All @@ -167,6 +171,7 @@ private GrpcCallContext(
this.endpointContext =
endpointContext == null ? EndpointContext.getDefaultInstance() : endpointContext;
this.isDirectPath = isDirectPath;
this.transportChannel = transportChannel;
}

/**
Expand Down Expand Up @@ -208,7 +213,13 @@ public GrpcCallContext withCredentials(Credentials newCredentials) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@Override
public TransportChannel getTransportChannel() {
return transportChannel;
}

@Override
Expand All @@ -232,7 +243,8 @@ public GrpcCallContext withTransportChannel(TransportChannel inputChannel) {
retrySettings,
retryableCodes,
endpointContext,
transportChannel.isDirectPath());
transportChannel.isDirectPath(),
inputChannel);
}

@Override
Expand All @@ -251,7 +263,8 @@ public GrpcCallContext withEndpointContext(EndpointContext endpointContext) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

/** This method is obsolete. Use {@link #withTimeoutDuration(java.time.Duration)} instead. */
Expand Down Expand Up @@ -286,7 +299,8 @@ public GrpcCallContext withTimeoutDuration(@Nullable java.time.Duration timeout)
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

/** This method is obsolete. Use {@link #getTimeoutDuration()} instead. */
Expand Down Expand Up @@ -335,7 +349,8 @@ public GrpcCallContext withStreamWaitTimeoutDuration(
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

/**
Expand Down Expand Up @@ -370,7 +385,8 @@ public GrpcCallContext withStreamIdleTimeoutDuration(
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@BetaApi("The surface for channel affinity is not stable yet and may change in the future.")
Expand All @@ -388,7 +404,8 @@ public GrpcCallContext withChannelAffinity(@Nullable Integer affinity) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@BetaApi("The surface for extra headers is not stable yet and may change in the future.")
Expand All @@ -410,7 +427,8 @@ public GrpcCallContext withExtraHeaders(Map<String, List<String>> extraHeaders)
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@Override
Expand All @@ -433,7 +451,8 @@ public GrpcCallContext withRetrySettings(RetrySettings retrySettings) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@Override
Expand All @@ -456,7 +475,8 @@ public GrpcCallContext withRetryableCodes(Set<StatusCode.Code> retryableCodes) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

@Override
Expand Down Expand Up @@ -558,7 +578,8 @@ public ApiCallContext merge(ApiCallContext inputCallContext) {
newRetrySettings,
newRetryableCodes,
endpointContext,
newIsDirectPath);
newIsDirectPath,
transportChannel);
}

/** The {@link Channel} set on this context. */
Expand Down Expand Up @@ -641,7 +662,8 @@ public GrpcCallContext withChannel(Channel newChannel) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

/** Returns a new instance with the call options set to the given call options. */
Expand All @@ -659,7 +681,8 @@ public GrpcCallContext withCallOptions(CallOptions newCallOptions) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

public GrpcCallContext withRequestParamsDynamicHeaderOption(String requestParams) {
Expand Down Expand Up @@ -704,7 +727,8 @@ public <T> GrpcCallContext withOption(Key<T> key, T value) {
retrySettings,
retryableCodes,
endpointContext,
isDirectPath);
isDirectPath,
transportChannel);
}

/** {@inheritDoc} */
Expand Down
8 changes: 8 additions & 0 deletions ...rm-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ public Channel getChannel() {
return getManagedChannel();
}

@Override
public void refresh() {
Channel channel = getChannel();
if (channel instanceof ChannelPool) {
((ChannelPool) channel).refresh();
}
}

@Override
public void shutdown() {
getManagedChannel().shutdown();
Expand Down
Loading
Loading