|
| 1 | +/* |
| 2 | + * Copyright 2026 Google LLC |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package com.google.cloud.bigtable.admin.v2.stub; |
| 17 | + |
| 18 | +import com.google.api.core.ApiAsyncFunction; |
| 19 | +import com.google.api.core.ApiClock; |
| 20 | +import com.google.api.core.ApiFunction; |
| 21 | +import com.google.api.core.ApiFuture; |
| 22 | +import com.google.api.core.ApiFutures; |
| 23 | +import com.google.api.core.InternalApi; |
| 24 | +import com.google.api.gax.retrying.ExponentialPollAlgorithm; |
| 25 | +import com.google.api.gax.retrying.NonCancellableFuture; |
| 26 | +import com.google.api.gax.retrying.ResultRetryAlgorithmWithContext; |
| 27 | +import com.google.api.gax.retrying.RetryAlgorithm; |
| 28 | +import com.google.api.gax.retrying.RetrySettings; |
| 29 | +import com.google.api.gax.retrying.RetryingContext; |
| 30 | +import com.google.api.gax.retrying.RetryingExecutor; |
| 31 | +import com.google.api.gax.retrying.RetryingFuture; |
| 32 | +import com.google.api.gax.retrying.ScheduledRetryingExecutor; |
| 33 | +import com.google.api.gax.retrying.TimedAttemptSettings; |
| 34 | +import com.google.api.gax.rpc.ApiCallContext; |
| 35 | +import com.google.api.gax.rpc.UnaryCallable; |
| 36 | +import com.google.bigtable.admin.v2.CheckConsistencyRequest; |
| 37 | +import com.google.bigtable.admin.v2.CheckConsistencyResponse; |
| 38 | +import com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest; |
| 39 | +import com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse; |
| 40 | +import com.google.cloud.bigtable.admin.v2.models.ConsistencyRequest; |
| 41 | +import com.google.common.annotations.VisibleForTesting; |
| 42 | +import com.google.common.util.concurrent.MoreExecutors; |
| 43 | +import java.util.concurrent.Callable; |
| 44 | +import java.util.concurrent.CancellationException; |
| 45 | +import java.util.concurrent.ScheduledExecutorService; |
| 46 | + |
| 47 | +/** |
| 48 | + * Decoupled modern consistency polling callable for V2 client. |
| 49 | + * |
| 50 | + * <p>This callable waits until either replication or Data Boost has caught up to the point it was |
| 51 | + * called. It wraps GenerateConsistencyToken and CheckConsistency RPCs and contains absolutely no |
| 52 | + * reference or dependency on the data module. |
| 53 | + */ |
| 54 | +@InternalApi |
| 55 | +public class AwaitConsistencyCallableV2 extends UnaryCallable<ConsistencyRequest, Void> { |
| 56 | + private final UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse> |
| 57 | + generateCallable; |
| 58 | + private final UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable; |
| 59 | + private final RetryingExecutor<CheckConsistencyResponse> executor; |
| 60 | + |
| 61 | + @InternalApi |
| 62 | + public static AwaitConsistencyCallableV2 create( |
| 63 | + UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse> |
| 64 | + generateCallable, |
| 65 | + UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable, |
| 66 | + ApiClock clock, |
| 67 | + ScheduledExecutorService executor, |
| 68 | + RetrySettings pollingSettings) { |
| 69 | + |
| 70 | + RetryAlgorithm<CheckConsistencyResponse> retryAlgorithm = |
| 71 | + new RetryAlgorithm<>( |
| 72 | + new PollResultAlgorithm(), new ExponentialPollAlgorithm(pollingSettings, clock)); |
| 73 | + |
| 74 | + RetryingExecutor<CheckConsistencyResponse> retryingExecutor = |
| 75 | + new ScheduledRetryingExecutor<>(retryAlgorithm, executor); |
| 76 | + |
| 77 | + return new AwaitConsistencyCallableV2(generateCallable, checkCallable, retryingExecutor); |
| 78 | + } |
| 79 | + |
| 80 | + @VisibleForTesting |
| 81 | + AwaitConsistencyCallableV2( |
| 82 | + UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse> |
| 83 | + generateCallable, |
| 84 | + UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable, |
| 85 | + RetryingExecutor<CheckConsistencyResponse> executor) { |
| 86 | + this.generateCallable = generateCallable; |
| 87 | + this.checkCallable = checkCallable; |
| 88 | + this.executor = executor; |
| 89 | + } |
| 90 | + |
| 91 | + @Override |
| 92 | + public ApiFuture<Void> futureCall( |
| 93 | + final ConsistencyRequest consistencyRequest, final ApiCallContext apiCallContext) { |
| 94 | + |
| 95 | + // If the token is already provided, skip generation and poll directly. |
| 96 | + if (consistencyRequest.getConsistencyToken() != null) { |
| 97 | + CheckConsistencyRequest request = |
| 98 | + consistencyRequest.toCheckConsistencyProto(consistencyRequest.getConsistencyToken()); |
| 99 | + return pollToken(request, apiCallContext); |
| 100 | + } |
| 101 | + |
| 102 | + ApiFuture<GenerateConsistencyTokenResponse> tokenFuture = |
| 103 | + generateToken(consistencyRequest.toGenerateTokenProto(), apiCallContext); |
| 104 | + |
| 105 | + return ApiFutures.transformAsync( |
| 106 | + tokenFuture, |
| 107 | + new ApiAsyncFunction<GenerateConsistencyTokenResponse, Void>() { |
| 108 | + @Override |
| 109 | + public ApiFuture<Void> apply(GenerateConsistencyTokenResponse input) { |
| 110 | + CheckConsistencyRequest request = |
| 111 | + consistencyRequest.toCheckConsistencyProto(input.getConsistencyToken()); |
| 112 | + return pollToken(request, apiCallContext); |
| 113 | + } |
| 114 | + }, |
| 115 | + MoreExecutors.directExecutor()); |
| 116 | + } |
| 117 | + |
| 118 | + private ApiFuture<GenerateConsistencyTokenResponse> generateToken( |
| 119 | + GenerateConsistencyTokenRequest generateRequest, ApiCallContext context) { |
| 120 | + return generateCallable.futureCall(generateRequest, context); |
| 121 | + } |
| 122 | + |
| 123 | + private ApiFuture<Void> pollToken(CheckConsistencyRequest request, ApiCallContext context) { |
| 124 | + AttemptCallable<CheckConsistencyRequest, CheckConsistencyResponse> attemptCallable = |
| 125 | + new AttemptCallable<>(checkCallable, request, context); |
| 126 | + RetryingFuture<CheckConsistencyResponse> retryingFuture = |
| 127 | + executor.createFuture(attemptCallable); |
| 128 | + attemptCallable.setExternalFuture(retryingFuture); |
| 129 | + attemptCallable.call(); |
| 130 | + |
| 131 | + return ApiFutures.transform( |
| 132 | + retryingFuture, |
| 133 | + new ApiFunction<CheckConsistencyResponse, Void>() { |
| 134 | + @Override |
| 135 | + public Void apply(CheckConsistencyResponse input) { |
| 136 | + return null; |
| 137 | + } |
| 138 | + }, |
| 139 | + MoreExecutors.directExecutor()); |
| 140 | + } |
| 141 | + |
| 142 | + /** A callable representing an attempt to make an RPC call. */ |
| 143 | + private static class AttemptCallable<RequestT, ResponseT> implements Callable<ResponseT> { |
| 144 | + private final UnaryCallable<RequestT, ResponseT> callable; |
| 145 | + private final RequestT request; |
| 146 | + |
| 147 | + private volatile RetryingFuture<ResponseT> externalFuture; |
| 148 | + private final ApiCallContext callContext; |
| 149 | + |
| 150 | + AttemptCallable( |
| 151 | + UnaryCallable<RequestT, ResponseT> callable, RequestT request, ApiCallContext callContext) { |
| 152 | + this.callable = callable; |
| 153 | + this.request = request; |
| 154 | + this.callContext = callContext; |
| 155 | + } |
| 156 | + |
| 157 | + void setExternalFuture(RetryingFuture<ResponseT> externalFuture) { |
| 158 | + this.externalFuture = externalFuture; |
| 159 | + } |
| 160 | + |
| 161 | + @Override |
| 162 | + public ResponseT call() { |
| 163 | + try { |
| 164 | + // NOTE: unlike gax's AttemptCallable, this ignores rpc timeouts |
| 165 | + externalFuture.setAttemptFuture(new NonCancellableFuture<ResponseT>()); |
| 166 | + if (externalFuture.isDone()) { |
| 167 | + return null; |
| 168 | + } |
| 169 | + ApiFuture<ResponseT> internalFuture = callable.futureCall(request, callContext); |
| 170 | + externalFuture.setAttemptFuture(internalFuture); |
| 171 | + } catch (Throwable e) { |
| 172 | + externalFuture.setAttemptFuture(ApiFutures.<ResponseT>immediateFailedFuture(e)); |
| 173 | + } |
| 174 | + |
| 175 | + return null; |
| 176 | + } |
| 177 | + } |
| 178 | + |
| 179 | + /** |
| 180 | + * A polling algorithm for waiting for a consistent {@link CheckConsistencyResponse}. Please note |
| 181 | + * that this class doesn't handle retryable errors and expects the underlying callable chain to |
| 182 | + * handle this. |
| 183 | + */ |
| 184 | + private static class PollResultAlgorithm |
| 185 | + implements ResultRetryAlgorithmWithContext<CheckConsistencyResponse> { |
| 186 | + |
| 187 | + @Override |
| 188 | + public TimedAttemptSettings createNextAttempt( |
| 189 | + Throwable prevThrowable, |
| 190 | + CheckConsistencyResponse prevResponse, |
| 191 | + TimedAttemptSettings prevSettings) { |
| 192 | + return null; |
| 193 | + } |
| 194 | + |
| 195 | + @Override |
| 196 | + public TimedAttemptSettings createNextAttempt( |
| 197 | + RetryingContext context, |
| 198 | + Throwable previousThrowable, |
| 199 | + CheckConsistencyResponse previousResponse, |
| 200 | + TimedAttemptSettings previousSettings) { |
| 201 | + return null; |
| 202 | + } |
| 203 | + |
| 204 | + @Override |
| 205 | + public boolean shouldRetry( |
| 206 | + RetryingContext context, Throwable previousThrowable, CheckConsistencyResponse prevResponse) |
| 207 | + throws CancellationException { |
| 208 | + return prevResponse != null && !prevResponse.getConsistent(); |
| 209 | + } |
| 210 | + |
| 211 | + @Override |
| 212 | + public boolean shouldRetry(Throwable prevThrowable, CheckConsistencyResponse prevResponse) |
| 213 | + throws CancellationException { |
| 214 | + return prevResponse != null && !prevResponse.getConsistent(); |
| 215 | + } |
| 216 | + } |
| 217 | +} |
0 commit comments