feat: add API to serialize Queries to Proto

google-cloud-firestore/clirr-ignored-differences.xml

@@ -23,4 +23,17 @@
     <className>com/google/cloud/firestore/Firestore</className>
     <method>com.google.api.core.ApiFuture runAsyncTransaction(*)</method>
   </difference>
+
+  <difference>
+    <differenceType>7005</differenceType>
+    <className>com/google/cloud/firestore/*</className>
+    <method>*(com.google.cloud.firestore.FirestoreImpl, *)</method>
+    <to>*(com.google.cloud.firestore.FirestoreRpcContext, *)</to>
+  </difference>
+  <difference>
+    <differenceType>7009</differenceType>
+    <className>com/google/cloud/firestore/*</className>
+    <method>*(com.google.cloud.firestore.FirestoreImpl, *)</method>
+  </difference>
+
 </differences>

google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionReference.java

@@ -19,8 +19,11 @@
 import com.google.api.core.ApiFunction;
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ApiFutures;
+import com.google.api.core.InternalExtensionOnly;
 import com.google.api.gax.rpc.ApiException;
 import com.google.api.gax.rpc.ApiExceptions;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.cloud.firestore.spi.v1.FirestoreRpc;
 import com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPagedResponse;
 import com.google.common.base.Preconditions;
 import com.google.common.util.concurrent.MoreExecutors;
@@ -40,16 +43,17 @@
  * test mocks. Subclassing is not supported in production code and new SDK releases may break code
  * that does so.
  */
+@InternalExtensionOnly
 public class CollectionReference extends Query {
 
   /**
    * Creates a CollectionReference from a complete collection path.
    *
-   * @param firestore The Firestore client.
+   * @param rpcContext The Firestore client.
    * @param collectionPath The Path of this collection.
    */
-  protected CollectionReference(FirestoreImpl firestore, ResourcePath collectionPath) {
-    super(firestore, collectionPath);
+  CollectionReference(FirestoreRpcContext<?> rpcContext, ResourcePath collectionPath) {
+    super(rpcContext, collectionPath);
   }
 
   /**
@@ -71,7 +75,7 @@ public String getId() {
   @Nullable
   public DocumentReference getParent() {
     ResourcePath parent = options.getParentPath();
-    return parent.isDocument() ? new DocumentReference(firestore, parent) : null;
+    return parent.isDocument() ? new DocumentReference(rpcContext, parent) : null;
   }
 
   /**
@@ -109,7 +113,7 @@ public DocumentReference document(@Nonnull String childPath) {
     Preconditions.checkArgument(
         documentPath.isDocument(),
         String.format("Path should point to a Document Reference: %s", getPath()));
-    return new DocumentReference(firestore, documentPath);
+    return new DocumentReference(rpcContext, documentPath);
   }
 
   /**
@@ -133,10 +137,12 @@ public Iterable<DocumentReference> listDocuments() {
     final ListDocumentsPagedResponse response;
 
     try {
-      response =
-          ApiExceptions.callAndTranslateApiException(
-              firestore.sendRequest(
-                  request.build(), firestore.getClient().listDocumentsPagedCallable()));
+      FirestoreRpc client = rpcContext.getClient();
+      UnaryCallable<ListDocumentsRequest, ListDocumentsPagedResponse> callable =
+          client.listDocumentsPagedCallable();
+      ListDocumentsRequest build = request.build();
+      ApiFuture<ListDocumentsPagedResponse> future = rpcContext.sendRequest(build, callable);
+      response = ApiExceptions.callAndTranslateApiException(future);
     } catch (ApiException exception) {
       throw FirestoreException.apiException(exception);
     }

google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentReference.java

@@ -19,6 +19,7 @@
 import com.google.api.core.ApiFunction;
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ApiFutures;
+import com.google.api.core.InternalExtensionOnly;
 import com.google.api.gax.rpc.ApiException;
 import com.google.api.gax.rpc.ApiExceptions;
 import com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPagedResponse;
@@ -42,15 +43,16 @@
  * test mocks. Subclassing is not supported in production code and new SDK releases may break code
  * that does so.
  */
+@InternalExtensionOnly
 public class DocumentReference {
 
   private final ResourcePath path;
-  private final FirestoreImpl firestore;
+  private final FirestoreRpcContext<?> rpcContext;
 
-  protected DocumentReference(
-      FirestoreImpl firestore, ResourcePath path) { // Elevated access level for mocking.
+  DocumentReference(
+      FirestoreRpcContext<?> rpcContext, ResourcePath path) { // Elevated access level for mocking.
     this.path = path;
-    this.firestore = firestore;
+    this.rpcContext = rpcContext;
   }
 
   /*
@@ -60,7 +62,7 @@ protected DocumentReference(
    */
   @Nonnull
   public Firestore getFirestore() {
-    return firestore;
+    return rpcContext.getFirestore();
   }
 
   /**
@@ -102,7 +104,7 @@ String getName() {
    */
   @Nonnull
   public CollectionReference getParent() {
-    return new CollectionReference(firestore, path.getParent());
+    return new CollectionReference(rpcContext, path.getParent());
   }
 
   /**
@@ -114,7 +116,7 @@ public CollectionReference getParent() {
    */
   @Nonnull
   public CollectionReference collection(@Nonnull String collectionPath) {
-    return new CollectionReference(firestore, path.append(collectionPath));
+    return new CollectionReference(rpcContext, path.append(collectionPath));
   }
 
   /**
@@ -144,7 +146,7 @@ public T apply(List<T> results) {
    */
   @Nonnull
   public ApiFuture<WriteResult> create(@Nonnull Map<String, Object> fields) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.create(this, fields).commit());
   }
 
@@ -157,7 +159,7 @@ public ApiFuture<WriteResult> create(@Nonnull Map<String, Object> fields) {
    */
   @Nonnull
   public ApiFuture<WriteResult> create(@Nonnull Object pojo) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.create(this, pojo).commit());
   }
 
@@ -170,7 +172,7 @@ public ApiFuture<WriteResult> create(@Nonnull Object pojo) {
    */
   @Nonnull
   public ApiFuture<WriteResult> set(@Nonnull Map<String, Object> fields) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.set(this, fields).commit());
   }
 
@@ -186,7 +188,7 @@ public ApiFuture<WriteResult> set(@Nonnull Map<String, Object> fields) {
   @Nonnull
   public ApiFuture<WriteResult> set(
       @Nonnull Map<String, Object> fields, @Nonnull SetOptions options) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.set(this, fields, options).commit());
   }
 
@@ -199,7 +201,7 @@ public ApiFuture<WriteResult> set(
    */
   @Nonnull
   public ApiFuture<WriteResult> set(@Nonnull Object pojo) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.set(this, pojo).commit());
   }
 
@@ -214,7 +216,7 @@ public ApiFuture<WriteResult> set(@Nonnull Object pojo) {
    */
   @Nonnull
   public ApiFuture<WriteResult> set(@Nonnull Object pojo, @Nonnull SetOptions options) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.set(this, pojo, options).commit());
   }
 
@@ -227,7 +229,7 @@ public ApiFuture<WriteResult> set(@Nonnull Object pojo, @Nonnull SetOptions opti
    */
   @Nonnull
   public ApiFuture<WriteResult> update(@Nonnull Map<String, Object> fields) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.update(this, fields).commit());
   }
 
@@ -241,7 +243,7 @@ public ApiFuture<WriteResult> update(@Nonnull Map<String, Object> fields) {
    */
   @Nonnull
   public ApiFuture<WriteResult> update(@Nonnull Map<String, Object> fields, Precondition options) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.update(this, fields, options).commit());
   }
 
@@ -257,7 +259,7 @@ public ApiFuture<WriteResult> update(@Nonnull Map<String, Object> fields, Precon
   @Nonnull
   public ApiFuture<WriteResult> update(
       @Nonnull String field, @Nullable Object value, Object... moreFieldsAndValues) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.update(this, field, value, moreFieldsAndValues).commit());
   }
 
@@ -273,7 +275,7 @@ public ApiFuture<WriteResult> update(
   @Nonnull
   public ApiFuture<WriteResult> update(
       @Nonnull FieldPath fieldPath, @Nullable Object value, Object... moreFieldsAndValues) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.update(this, fieldPath, value, moreFieldsAndValues).commit());
   }
 
@@ -293,7 +295,7 @@ public ApiFuture<WriteResult> update(
       @Nonnull String field,
       @Nullable Object value,
       Object... moreFieldsAndValues) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(
         writeBatch.update(this, options, field, value, moreFieldsAndValues).commit());
   }
@@ -314,7 +316,7 @@ public ApiFuture<WriteResult> update(
       @Nonnull FieldPath fieldPath,
       @Nullable Object value,
       Object... moreFieldsAndValues) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(
         writeBatch.update(this, options, fieldPath, value, moreFieldsAndValues).commit());
   }
@@ -327,7 +329,7 @@ public ApiFuture<WriteResult> update(
    */
   @Nonnull
   public ApiFuture<WriteResult> delete(@Nonnull Precondition options) {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.delete(this, options).commit());
   }
 
@@ -338,7 +340,7 @@ public ApiFuture<WriteResult> delete(@Nonnull Precondition options) {
    */
   @Nonnull
   public ApiFuture<WriteResult> delete() {
-    WriteBatch writeBatch = firestore.batch();
+    WriteBatch writeBatch = rpcContext.getFirestore().batch();
     return extractFirst(writeBatch.delete(this).commit());
   }
 
@@ -351,7 +353,7 @@ public ApiFuture<WriteResult> delete() {
    */
   @Nonnull
   public ApiFuture<DocumentSnapshot> get() {
-    return extractFirst(firestore.getAll(this));
+    return extractFirst(rpcContext.getFirestore().getAll(this));
   }
 
   /**
@@ -364,7 +366,8 @@ public ApiFuture<DocumentSnapshot> get() {
    */
   @Nonnull
   public ApiFuture<DocumentSnapshot> get(FieldMask fieldMask) {
-    return extractFirst(firestore.getAll(new DocumentReference[] {this}, fieldMask));
+    return extractFirst(
+        rpcContext.getFirestore().getAll(new DocumentReference[] {this}, fieldMask));
   }
 
   /**
@@ -382,8 +385,8 @@ public Iterable<CollectionReference> listCollections() {
     try {
       response =
           ApiExceptions.callAndTranslateApiException(
-              firestore.sendRequest(
-                  request.build(), firestore.getClient().listCollectionIdsPagedCallable()));
+              rpcContext.sendRequest(
+                  request.build(), rpcContext.getClient().listCollectionIdsPagedCallable()));
     } catch (ApiException exception) {
       throw FirestoreException.apiException(exception);
     }
@@ -456,7 +459,7 @@ public void onEvent(
                 }
                 listener.onEvent(
                     DocumentSnapshot.fromMissing(
-                        firestore, DocumentReference.this, value.getReadTime()),
+                        rpcContext, DocumentReference.this, value.getReadTime()),
                     null);
               }
             });
@@ -471,7 +474,7 @@ public void onEvent(
   @Nonnull
   public ListenerRegistration addSnapshotListener(
       @Nonnull EventListener<DocumentSnapshot> listener) {
-    return addSnapshotListener(firestore.getClient().getExecutor(), listener);
+    return addSnapshotListener(rpcContext.getClient().getExecutor(), listener);
   }
 
   ResourcePath getResourcePath() {
@@ -498,11 +501,11 @@ public boolean equals(Object obj) {
       return false;
     }
     DocumentReference that = (DocumentReference) obj;
-    return Objects.equals(path, that.path) && Objects.equals(firestore, that.firestore);
+    return Objects.equals(path, that.path) && Objects.equals(rpcContext, that.rpcContext);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(path, firestore);
+    return Objects.hash(path, rpcContext);
   }
 }