Skip to content

feat(bigtable): append java-bigtable-batcher token to x-goog-api-client for batcher RPCs #14364

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

Open
mutianf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(bigtable): append java-bigtable-batcher token to x-goog-api-client for batcher RPCs #14364

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
19 changes: 13 additions & 6 deletions ...d-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
import com.google.bigtable.v2.ReadRowsResponse;
import com.google.bigtable.v2.RowRange;
import com.google.bigtable.v2.SampleRowKeysResponse;
import com.google.cloud.bigtable.Version;
import com.google.cloud.bigtable.data.v2.internal.NameUtil;
import com.google.cloud.bigtable.data.v2.internal.PrepareQueryRequest;
import com.google.cloud.bigtable.data.v2.internal.PrepareResponse;
Expand Down Expand Up @@ -116,6 +117,7 @@
import com.google.common.base.Functions;
import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.protobuf.ByteString;
import io.grpc.MethodDescriptor;
Expand Down Expand Up @@ -146,6 +148,7 @@ public class EnhancedBigtableStub implements AutoCloseable {

private static final String CLIENT_NAME = "Bigtable";
private static final long FLOW_CONTROL_ADJUSTING_INTERVAL_MS = TimeUnit.SECONDS.toMillis(20);
private static final String BATCHER_API_CLIENT_TOKEN = "java-bigtable-batcher/" + Version.VERSION;
private final ClientOperationSettings perOpSettings;
private final BigtableClientContext bigtableClientContext;

Expand Down Expand Up @@ -803,8 +806,7 @@ public Batcher<RowMutationEntry, Void> newMutateRowsBatcher(
perOpSettings.bulkMutateRowsSettings.getBatchingSettings(),
bigtableClientContext.getClientContext().getExecutor(),
bulkMutationFlowController,
MoreObjects.firstNonNull(
ctx, bigtableClientContext.getClientContext().getDefaultCallContext()));
batcherCallContext(ctx));
}

/**
Expand Down Expand Up @@ -835,8 +837,7 @@ public Batcher<RowMutationEntry, Void> newMutateRowsBatcher(
perOpSettings.bulkMutateRowsSettings.getBatchingSettings(),
bigtableClientContext.getClientContext().getExecutor(),
bulkMutationFlowController,
MoreObjects.firstNonNull(
ctx, bigtableClientContext.getClientContext().getDefaultCallContext()));
batcherCallContext(ctx));
}

/**
Expand Down Expand Up @@ -864,8 +865,7 @@ public Batcher<ByteString, Row> newBulkReadRowsBatcher(
perOpSettings.bulkReadRowsSettings.getBatchingSettings(),
bigtableClientContext.getClientContext().getExecutor(),
null,
MoreObjects.firstNonNull(
ctx, bigtableClientContext.getClientContext().getDefaultCallContext()));
batcherCallContext(ctx));
}

/**
Expand Down Expand Up @@ -1187,6 +1187,13 @@ private <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUserFacin
bigtableClientContext.getClientContext().getDefaultCallContext());
}

private ApiCallContext batcherCallContext(@Nullable GrpcCallContext userCtx) {
return MoreObjects.firstNonNull(
userCtx, bigtableClientContext.getClientContext().getDefaultCallContext())
.withExtraHeaders(
ImmutableMap.of("x-goog-api-client", ImmutableList.of(BATCHER_API_CLIENT_TOKEN)));
}

private Map<String, String> composeRequestParams(
String appProfileId, String tableName, String authorizedViewName) {
if (tableName.isEmpty() && !authorizedViewName.isEmpty()) {
Expand Down
44 changes: 43 additions & 1 deletion ...ogle-cloud-bigtable/src/test/java/com/google/cloud/bigtable/data/v2/stub/HeadersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
import com.google.cloud.bigtable.data.v2.models.RowMutationEntry;
import com.google.cloud.bigtable.data.v2.models.TableId;
import com.google.cloud.bigtable.data.v2.models.sql.PreparedStatement;
import com.google.protobuf.ByteString;
import com.google.rpc.Status;
import io.grpc.Metadata;
import io.grpc.Server;
Expand Down Expand Up @@ -111,7 +112,7 @@ public void setUp() throws Exception {
HeaderProvider headerProvider =
FixedHeaderProvider.create(TEST_FIXED_HEADER_STRING, "test_header_value");

// Force immediate flush
// Force immediate flush for both batcher types
settings
.stubSettings()
.setHeaderProvider(headerProvider)
Expand All @@ -120,6 +121,13 @@ public void setUp() throws Exception {
settings.stubSettings().bulkMutateRowsSettings().getBatchingSettings().toBuilder()
.setElementCountThreshold(1L)
.build());
settings
.stubSettings()
.bulkReadRowsSettings()
.setBatchingSettings(
settings.stubSettings().bulkReadRowsSettings().getBatchingSettings().toBuilder()
.setElementCountThreshold(1L)
.build());

client = BigtableDataClient.create(settings.build());
}
Expand Down Expand Up @@ -207,6 +215,40 @@ public void prepareQueryTest() {
verifyHeaderSent(true);
}

@Test
public void bulkMutationBatcherHasBatcherToken() throws Exception {
try (Batcher<RowMutationEntry, Void> batcher = client.newBulkMutationBatcher(TABLE_ID)) {
batcher.add(RowMutationEntry.create("fake-key").deleteRow());
}
Metadata metadata = sentMetadata.take();
assertThat(hasApiClientToken(metadata, "java-bigtable-batcher")).isTrue();
}

@Test
public void bulkReadRowsBatcherHasBatcherToken() throws Exception {
try (Batcher<ByteString, Row> batcher = client.newBulkReadRowsBatcher(TABLE_ID)) {
batcher.add(ByteString.copyFromUtf8("fake-key"));
}
Metadata metadata = sentMetadata.take();
assertThat(hasApiClientToken(metadata, "java-bigtable-batcher")).isTrue();
}

@Test
public void regularRpcDoesNotHaveBatcherToken() throws Exception {
client.mutateRowAsync(RowMutation.create(TABLE_ID, "fake-key").deleteRow()).get();
Metadata metadata = sentMetadata.take();
assertThat(hasApiClientToken(metadata, "java-bigtable-batcher")).isFalse();
}

private static boolean hasApiClientToken(Metadata metadata, String token) {
Iterable<String> values = metadata.getAll(API_CLIENT_HEADER_KEY);
if (values == null) return false;
for (String value : values) {
if (value.contains(token)) return true;
}
return false;
}

private void verifyHeaderSent() {
verifyHeaderSent(false);
}
Expand Down
Loading