Skip to content
This repository was archived by the owner on Aug 30, 2026. It is now read-only.

Commit b68d628

Browse files
committed
refactor: decouple ConsistencyRequest from TableAdminRequestContext
This commit updates the internal plumbing for `ConsistencyRequest` and `AwaitConsistencyCallable` to support fully qualified table names without breaking the existing public API for the legacy `BigtableTableAdminClient`. b/502616786
1 parent 5c4a2c7 commit b68d628

3 files changed

Lines changed: 77 additions & 12 deletions

File tree

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/ConsistencyRequest.java‎

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,11 @@ public abstract class ConsistencyRequest {
4343
@Nullable
4444
public abstract String getConsistencyToken();
4545

46+
protected abstract boolean isFullyQualified();
47+
4648
public static ConsistencyRequest forReplication(String tableId) {
4749
return new AutoValue_ConsistencyRequest(
48-
tableId, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, null);
50+
tableId, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, null, false);
4951
}
5052

5153
/**
@@ -59,17 +61,32 @@ public static ConsistencyRequest forReplication(String tableId, String consisten
5961
Preconditions.checkNotNull(consistencyToken, "consistencyToken must not be null");
6062

6163
return new AutoValue_ConsistencyRequest(
62-
tableId, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, consistencyToken);
64+
tableId, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, consistencyToken, false);
6365
}
6466

6567
public static ConsistencyRequest forDataBoost(String tableId) {
6668
return new AutoValue_ConsistencyRequest(
67-
tableId, CheckConsistencyRequest.ModeCase.DATA_BOOST_READ_LOCAL_WRITES, null);
69+
tableId, CheckConsistencyRequest.ModeCase.DATA_BOOST_READ_LOCAL_WRITES, null, false);
70+
}
71+
72+
@InternalApi
73+
public static ConsistencyRequest forReplicationFromTableName(String tableName) {
74+
return new AutoValue_ConsistencyRequest(
75+
tableName, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, null, true);
76+
}
77+
78+
@InternalApi
79+
public static ConsistencyRequest forReplicationFromTableName(String tableName, String consistencyToken) {
80+
Preconditions.checkNotNull(consistencyToken, "consistencyToken must not be null");
81+
82+
return new AutoValue_ConsistencyRequest(
83+
tableName, CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES, consistencyToken, true);
6884
}
6985

7086
@InternalApi
7187
public CheckConsistencyRequest toCheckConsistencyProto(
7288
TableAdminRequestContext requestContext, String token) {
89+
Preconditions.checkState(!isFullyQualified(), "Use toCheckConsistencyProto(String token) for fully qualified table names.");
7390
CheckConsistencyRequest.Builder builder = CheckConsistencyRequest.newBuilder();
7491
TableName tableName =
7592
TableName.of(requestContext.getProjectId(), requestContext.getInstanceId(), getTableId());
@@ -83,13 +100,35 @@ public CheckConsistencyRequest toCheckConsistencyProto(
83100
return builder.setName(tableName.toString()).setConsistencyToken(token).build();
84101
}
85102

103+
@InternalApi
104+
public CheckConsistencyRequest toCheckConsistencyProto(String token) {
105+
Preconditions.checkState(isFullyQualified(), "Use toCheckConsistencyProto(TableAdminRequestContext, String) for non-qualified table names.");
106+
CheckConsistencyRequest.Builder builder = CheckConsistencyRequest.newBuilder();
107+
108+
if (getMode().equals(CheckConsistencyRequest.ModeCase.STANDARD_READ_REMOTE_WRITES)) {
109+
builder.setStandardReadRemoteWrites(StandardReadRemoteWrites.newBuilder().build());
110+
} else {
111+
builder.setDataBoostReadLocalWrites(DataBoostReadLocalWrites.newBuilder().build());
112+
}
113+
114+
return builder.setName(getTableId()).setConsistencyToken(token).build();
115+
}
116+
86117
@InternalApi
87118
public GenerateConsistencyTokenRequest toGenerateTokenProto(
88119
TableAdminRequestContext requestContext) {
120+
Preconditions.checkState(!isFullyQualified(), "Use toGenerateTokenProto() for fully qualified table names.");
89121
GenerateConsistencyTokenRequest.Builder builder = GenerateConsistencyTokenRequest.newBuilder();
90122
TableName tableName =
91123
TableName.of(requestContext.getProjectId(), requestContext.getInstanceId(), getTableId());
92124

93125
return builder.setName(tableName.toString()).build();
94126
}
127+
128+
@InternalApi
129+
public GenerateConsistencyTokenRequest toGenerateTokenProto() {
130+
Preconditions.checkState(isFullyQualified(), "Use toGenerateTokenProto(TableAdminRequestContext) for non-qualified table names.");
131+
GenerateConsistencyTokenRequest.Builder builder = GenerateConsistencyTokenRequest.newBuilder();
132+
return builder.setName(getTableId()).build();
133+
}
95134
}

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/stub/AwaitConsistencyCallable.java‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import com.google.common.util.concurrent.MoreExecutors;
4343
import java.util.concurrent.Callable;
4444
import java.util.concurrent.CancellationException;
45+
import javax.annotation.Nullable;
4546

4647
/**
4748
* Callable that waits until either replication or Data Boost has caught up to the point it was
@@ -56,15 +57,15 @@ class AwaitConsistencyCallable extends UnaryCallable<ConsistencyRequest, Void> {
5657
private final UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable;
5758
private final RetryingExecutor<CheckConsistencyResponse> executor;
5859

59-
private final TableAdminRequestContext requestContext;
60+
@Nullable private final TableAdminRequestContext requestContext;
6061

6162
static AwaitConsistencyCallable create(
6263
UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse>
6364
generateCallable,
6465
UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable,
6566
ClientContext clientContext,
6667
RetrySettings pollingSettings,
67-
TableAdminRequestContext requestContext) {
68+
@Nullable TableAdminRequestContext requestContext) {
6869

6970
RetryAlgorithm<CheckConsistencyResponse> retryAlgorithm =
7071
new RetryAlgorithm<>(
@@ -78,13 +79,22 @@ static AwaitConsistencyCallable create(
7879
generateCallable, checkCallable, retryingExecutor, requestContext);
7980
}
8081

82+
static AwaitConsistencyCallable create(
83+
UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse>
84+
generateCallable,
85+
UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable,
86+
ClientContext clientContext,
87+
RetrySettings pollingSettings) {
88+
return create(generateCallable, checkCallable, clientContext, pollingSettings, null);
89+
}
90+
8191
@VisibleForTesting
8292
AwaitConsistencyCallable(
8393
UnaryCallable<GenerateConsistencyTokenRequest, GenerateConsistencyTokenResponse>
8494
generateCallable,
8595
UnaryCallable<CheckConsistencyRequest, CheckConsistencyResponse> checkCallable,
8696
RetryingExecutor<CheckConsistencyResponse> executor,
87-
TableAdminRequestContext requestContext) {
97+
@Nullable TableAdminRequestContext requestContext) {
8898
this.generateCallable = generateCallable;
8999
this.checkCallable = checkCallable;
90100
this.executor = executor;
@@ -98,22 +108,30 @@ public ApiFuture<Void> futureCall(
98108
// If the token is already provided, skip generation and poll directly.
99109
if (consistencyRequest.getConsistencyToken() != null) {
100110
CheckConsistencyRequest request =
101-
consistencyRequest.toCheckConsistencyProto(
102-
requestContext, consistencyRequest.getConsistencyToken());
111+
requestContext == null
112+
? consistencyRequest.toCheckConsistencyProto(consistencyRequest.getConsistencyToken())
113+
: consistencyRequest.toCheckConsistencyProto(
114+
requestContext, consistencyRequest.getConsistencyToken());
103115
return pollToken(request, apiCallContext);
104116
}
105117

106118
ApiFuture<GenerateConsistencyTokenResponse> tokenFuture =
107-
generateToken(consistencyRequest.toGenerateTokenProto(requestContext), apiCallContext);
119+
generateToken(
120+
requestContext == null
121+
? consistencyRequest.toGenerateTokenProto()
122+
: consistencyRequest.toGenerateTokenProto(requestContext),
123+
apiCallContext);
108124

109125
return ApiFutures.transformAsync(
110126
tokenFuture,
111127
new ApiAsyncFunction<GenerateConsistencyTokenResponse, Void>() {
112128
@Override
113129
public ApiFuture<Void> apply(GenerateConsistencyTokenResponse input) {
114130
CheckConsistencyRequest request =
115-
consistencyRequest.toCheckConsistencyProto(
116-
requestContext, input.getConsistencyToken());
131+
requestContext == null
132+
? consistencyRequest.toCheckConsistencyProto(input.getConsistencyToken())
133+
: consistencyRequest.toCheckConsistencyProto(
134+
requestContext, input.getConsistencyToken());
117135
return pollToken(request, apiCallContext);
118136
}
119137
},

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ public class EnhancedBigtableTableAdminStub extends GrpcBigtableTableAdminStub {
5454
private final BigtableTableAdminStubSettings settings;
5555
private final ClientContext clientContext;
5656

57+
@javax.annotation.Nullable
5758
private final TableAdminRequestContext requestContext;
5859

5960
@Deprecated private final AwaitReplicationCallable awaitReplicationCallable;
@@ -62,6 +63,13 @@ public class EnhancedBigtableTableAdminStub extends GrpcBigtableTableAdminStub {
6263
private final OperationCallable<Void, Empty, OptimizeRestoredTableMetadata>
6364
optimizeRestoredTableOperationBaseCallable;
6465

66+
public static EnhancedBigtableTableAdminStub createEnhanced(
67+
BigtableTableAdminStubSettings settings)
68+
throws IOException {
69+
return new EnhancedBigtableTableAdminStub(
70+
settings, ClientContext.create(settings), null);
71+
}
72+
6573
public static EnhancedBigtableTableAdminStub createEnhanced(
6674
BigtableTableAdminStubSettings settings, TableAdminRequestContext requestContext)
6775
throws IOException {
@@ -72,7 +80,7 @@ public static EnhancedBigtableTableAdminStub createEnhanced(
7280
private EnhancedBigtableTableAdminStub(
7381
BigtableTableAdminStubSettings settings,
7482
ClientContext clientContext,
75-
TableAdminRequestContext requestContext)
83+
@javax.annotation.Nullable TableAdminRequestContext requestContext)
7684
throws IOException {
7785
super(settings, clientContext);
7886

0 commit comments

Comments
 (0)