Skip to content

feat(firestore): add x-goog-is-transaction routing header #14680

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
nikhilchowdary wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(firestore): add x-goog-is-transaction routing header #14680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
824417b
feat(firestore): add x-goog-is-transaction routing header
nikhilchowdary Oct 17, 2026
b2ce40f
Apply suggestion from @gemini-code-assist[bot]
nikhilchowdary Oct 17, 2026
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
92 changes: 80 additions & 12 deletions ...gle-cloud-firestore/src/main/java/com/google/cloud/firestore/spi/v1/GrpcFirestoreRpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,18 @@

package com.google.cloud.firestore.spi.v1;

import com.google.api.core.ApiFuture;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.core.GaxProperties;
import com.google.api.gax.grpc.GrpcCallContext;
import com.google.api.gax.grpc.GrpcTransportChannel;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.BidiStreamingCallable;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.HeaderProvider;
import com.google.api.gax.rpc.NoHeaderProvider;
import com.google.api.gax.rpc.ResponseObserver;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.TransportChannel;
import com.google.api.gax.rpc.UnaryCallable;
Expand All @@ -41,6 +44,9 @@
import com.google.cloud.firestore.v1.stub.GrpcFirestoreStub;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.firestore.v1.BatchGetDocumentsRequest;
import com.google.firestore.v1.BatchGetDocumentsResponse;
import com.google.firestore.v1.BatchWriteRequest;
Expand Down Expand Up @@ -70,20 +76,37 @@
import java.util.Collections;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;

/**
* GRPC client implementation of the Firestore RPC methods. Exposes FirestoreOptions on top of the
* GRPC-based Firestore GAPIC client.
*/
public class GrpcFirestoreRpc implements FirestoreRpc {

private static final ApiCallContext TRANSACTION_CALL_CONTEXT =
GrpcCallContext.createDefault()
.withExtraHeaders(ImmutableMap.of("x-goog-is-transaction", ImmutableList.of("true")));

private static final ApiCallContext NON_TRANSACTION_CALL_CONTEXT =
GrpcCallContext.createDefault()
.withExtraHeaders(ImmutableMap.of("x-goog-is-transaction", ImmutableList.of("false")));

private final FirestoreStub firestoreStub;
private final ScheduledExecutorService executor;
private final ExecutorFactory<ScheduledExecutorService> executorFactory;
private final ClientContext clientContext;

private boolean closed;

@VisibleForTesting
GrpcFirestoreRpc(FirestoreStub firestoreStub) {
this.firestoreStub = firestoreStub;
this.executor = null;
this.executorFactory = null;
this.clientContext = null;
}

public GrpcFirestoreRpc(final FirestoreOptions options) throws IOException {
GrpcTransportOptions transportOptions = (GrpcTransportOptions) options.getTransportOptions();
executorFactory = transportOptions.getExecutorFactory();
Expand Down Expand Up @@ -221,69 +244,114 @@ public ScheduledExecutorService getExecutor() {

@Override
public UnaryCallable<CommitRequest, CommitResponse> commitCallable() {
return firestoreStub.commitCallable();
return withRoutingHeaders(
firestoreStub.commitCallable(), req -> !req.getTransaction().isEmpty());
}

@Override
public UnaryCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable() {
return firestoreStub.batchWriteCallable();
return firestoreStub.batchWriteCallable().withDefaultCallContext(NON_TRANSACTION_CALL_CONTEXT);
}

@Override
public ServerStreamingCallable<BatchGetDocumentsRequest, BatchGetDocumentsResponse>
batchGetDocumentsCallable() {
return firestoreStub.batchGetDocumentsCallable();
return withRoutingHeaders(
firestoreStub.batchGetDocumentsCallable(),
req -> !req.getTransaction().isEmpty() || req.hasNewTransaction());
}

@Override
public ServerStreamingCallable<RunQueryRequest, RunQueryResponse> runQueryCallable() {
return firestoreStub.runQueryCallable();
return withRoutingHeaders(
firestoreStub.runQueryCallable(),
req -> !req.getTransaction().isEmpty() || req.hasNewTransaction());
}

@Override
public ServerStreamingCallable<ExecutePipelineRequest, ExecutePipelineResponse>
executePipelineCallable() {
return firestoreStub.executePipelineCallable();
return withRoutingHeaders(
firestoreStub.executePipelineCallable(),
req -> !req.getTransaction().isEmpty() || req.hasNewTransaction());
}

@Override
public ServerStreamingCallable<RunAggregationQueryRequest, RunAggregationQueryResponse>
runAggregationQueryCallable() {
return firestoreStub.runAggregationQueryCallable();
return withRoutingHeaders(
firestoreStub.runAggregationQueryCallable(),
req -> !req.getTransaction().isEmpty() || req.hasNewTransaction());
}

@Override
public UnaryCallable<BeginTransactionRequest, BeginTransactionResponse>
beginTransactionCallable() {
return firestoreStub.beginTransactionCallable();
return firestoreStub
.beginTransactionCallable()
.withDefaultCallContext(TRANSACTION_CALL_CONTEXT);
}

@Override
public UnaryCallable<RollbackRequest, Empty> rollbackCallable() {
return firestoreStub.rollbackCallable();
return firestoreStub.rollbackCallable().withDefaultCallContext(TRANSACTION_CALL_CONTEXT);
}

@Override
public UnaryCallable<ListCollectionIdsRequest, ListCollectionIdsPagedResponse>
listCollectionIdsPagedCallable() {
return firestoreStub.listCollectionIdsPagedCallable();
return firestoreStub
.listCollectionIdsPagedCallable()
.withDefaultCallContext(NON_TRANSACTION_CALL_CONTEXT);
}

@Override
public UnaryCallable<PartitionQueryRequest, FirestoreClient.PartitionQueryPagedResponse>
partitionQueryPagedCallable() {
return firestoreStub.partitionQueryPagedCallable();
return firestoreStub
.partitionQueryPagedCallable()
.withDefaultCallContext(NON_TRANSACTION_CALL_CONTEXT);
}

@Override
public UnaryCallable<ListDocumentsRequest, ListDocumentsPagedResponse>
listDocumentsPagedCallable() {
return firestoreStub.listDocumentsPagedCallable();
return withRoutingHeaders(
firestoreStub.listDocumentsPagedCallable(), req -> !req.getTransaction().isEmpty());
}

@Override
public BidiStreamingCallable<ListenRequest, ListenResponse> listenCallable() {
return firestoreStub.listenCallable();
return firestoreStub.listenCallable().withDefaultCallContext(NON_TRANSACTION_CALL_CONTEXT);
}

private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> withRoutingHeaders(
UnaryCallable<RequestT, ResponseT> callable, Predicate<RequestT> isTransaction) {
return new UnaryCallable<RequestT, ResponseT>() {
@Override
public ApiFuture<ResponseT> futureCall(RequestT request, ApiCallContext thisCallContext) {
ApiCallContext defaultContext =
isTransaction.test(request) ? TRANSACTION_CALL_CONTEXT : NON_TRANSACTION_CALL_CONTEXT;
return callable.futureCall(request, defaultContext.merge(thisCallContext));
}
};
}

private static <RequestT, ResponseT>
ServerStreamingCallable<RequestT, ResponseT> withRoutingHeaders(
ServerStreamingCallable<RequestT, ResponseT> callable,
Predicate<RequestT> isTransaction) {
return new ServerStreamingCallable<RequestT, ResponseT>() {
@Override
public void call(
RequestT request,
ResponseObserver<ResponseT> responseObserver,
ApiCallContext thisCallContext) {
ApiCallContext defaultContext =
isTransaction.test(request) ? TRANSACTION_CALL_CONTEXT : NON_TRANSACTION_CALL_CONTEXT;
callable.call(request, responseObserver, defaultContext.merge(thisCallContext));
}
};
}
Comment on lines +328 to 355

@gemini-code-assist gemini-code-assist Bot Oct 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using anonymous classes here is fragile because reflection-based tests (such as GrpcFirestoreRpcTest.getRetryData) rely on compiler-generated class names like GrpcFirestoreRpc$1 and GrpcFirestoreRpc$2. Any future addition or reordering of anonymous classes in this file will silently break these tests. Replacing them with named static nested classes makes the design robust and the class names stable.

  private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> withRoutingHeaders(
      UnaryCallable<RequestT, ResponseT> callable, Predicate<RequestT> isTransaction) {
    return new RoutingMetadataUnaryCallable<>(callable, isTransaction);
  }

  private static <RequestT, ResponseT>
      ServerStreamingCallable<RequestT, ResponseT> withRoutingHeaders(
          ServerStreamingCallable<RequestT, ResponseT> callable,
          Predicate<RequestT> isTransaction) {
    return new RoutingMetadataServerStreamingCallable<>(callable, isTransaction);
  }

  private static class RoutingMetadataUnaryCallable<RequestT, ResponseT>
      extends UnaryCallable<RequestT, ResponseT> {
    private final UnaryCallable<RequestT, ResponseT> callable;
    private final Predicate<RequestT> isTransaction;

    RoutingMetadataUnaryCallable(
        UnaryCallable<RequestT, ResponseT> callable, Predicate<RequestT> isTransaction) {
      this.callable = callable;
      this.isTransaction = isTransaction;
    }

    @Override
    public ApiFuture<ResponseT> futureCall(RequestT request, ApiCallContext thisCallContext) {
      ApiCallContext defaultContext =
          isTransaction.test(request) ? TRANSACTION_CALL_CONTEXT : NON_TRANSACTION_CALL_CONTEXT;
      return callable.futureCall(request, defaultContext.merge(thisCallContext));
    }
  }

  private static class RoutingMetadataServerStreamingCallable<RequestT, ResponseT>
      extends ServerStreamingCallable<RequestT, ResponseT> {
    private final ServerStreamingCallable<RequestT, ResponseT> callable;
    private final Predicate<RequestT> isTransaction;

    RoutingMetadataServerStreamingCallable(
        ServerStreamingCallable<RequestT, ResponseT> callable,
        Predicate<RequestT> isTransaction) {
      this.callable = callable;
      this.isTransaction = isTransaction;
    }

    @Override
    public void call(
        RequestT request,
        ResponseObserver<ResponseT> responseObserver,
        ApiCallContext thisCallContext) {
      ApiCallContext defaultContext =
          isTransaction.test(request) ? TRANSACTION_CALL_CONTEXT : NON_TRANSACTION_CALL_CONTEXT;
      callable.call(request, responseObserver, defaultContext.merge(thisCallContext));
    }
  }


// This class is needed solely to get access to protected method setInternalHeaderProvider()
Expand Down
Loading
Loading