Pipelines Implementation

firebase-firestore/CHANGELOG.md

@@ -1,5 +1,5 @@
 # Unreleased
-
+* [feature] Pipelines
 
 # 25.1.2
 * [fixed] Fixed a server and sdk mismatch in unicode string sorting. [#6615](//github.com/firebase/firebase-android-sdk/pull/6615)

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java

@@ -38,6 +38,8 @@
 import com.google.firebase.firestore.FirebaseFirestoreSettings;
 import com.google.firebase.firestore.ListenerRegistration;
 import com.google.firebase.firestore.MetadataChanges;
+import com.google.firebase.firestore.PipelineResult;
+import com.google.firebase.firestore.PipelineSnapshot;
 import com.google.firebase.firestore.Query;
 import com.google.firebase.firestore.QuerySnapshot;
 import com.google.firebase.firestore.Source;
@@ -98,7 +100,7 @@ public enum TargetBackend {
 
   // Set this to the desired enum value to change the target backend when running tests locally.
   // Note: DO NOT change this variable except for local testing.
-  private static final TargetBackend backendForLocalTesting = null;
+  private static final TargetBackend backendForLocalTesting = TargetBackend.NIGHTLY;
 
   private static final TargetBackend backend = getTargetBackend();
   private static final String EMULATOR_HOST = "10.0.2.2";
@@ -465,6 +467,15 @@ public static List<Map<String, Object>> querySnapshotToValues(QuerySnapshot quer
     return res;
   }
 
+  public static List<Map<String, Object>> pipelineSnapshotToValues(
+      PipelineSnapshot pipelineSnapshot) {
+    List<Map<String, Object>> res = new ArrayList<>();
+    for (PipelineResult result : pipelineSnapshot) {
+      res.add(result.getData());
+    }
+    return res;
+  }
+
   public static List<String> querySnapshotToIds(QuerySnapshot querySnapshot) {
     List<String> res = new ArrayList<>();
     for (DocumentSnapshot doc : querySnapshot) {
@@ -473,6 +484,15 @@ public static List<String> querySnapshotToIds(QuerySnapshot querySnapshot) {
     return res;
   }
 
+  public static List<String> pipelineSnapshotToIds(PipelineSnapshot pipelineResults) {
+    List<String> res = new ArrayList<>();
+    for (PipelineResult result : pipelineResults) {
+      DocumentReference ref = result.getRef();
+      res.add(ref == null ? null : ref.getId());
+    }
+    return res;
+  }
+
   public static void disableNetwork(FirebaseFirestore firestore) {
     if (firestoreStatus.get(firestore)) {
       waitFor(firestore.disableNetwork());
@@ -537,4 +557,24 @@ public static void checkOnlineAndOfflineResultsMatch(Query query, String... expe
       assertEquals(expected, querySnapshotToIds(docsFromCache));
     }
   }
+
+  /**
+   * Checks that running the query while online (against the backend/emulator) results in the same
+   * documents as running the query while offline. If `expectedDocs` is provided, it also checks
+   * that both online and offline query result is equal to the expected documents.
+   *
+   * @param query The query to check
+   * @param expectedDocs Ordered list of document keys that are expected to match the query
+   */
+  public static void checkQueryAndPipelineResultsMatch(Query query, String... expectedDocs) {
+    QuerySnapshot docsFromQuery = waitFor(query.get(Source.SERVER));
+    PipelineSnapshot docsFromPipeline =
+        waitFor(query.getFirestore().pipeline().convertFrom(query).execute());
+
+    assertEquals(querySnapshotToIds(docsFromQuery), pipelineSnapshotToIds(docsFromPipeline));
+    List<String> expected = asList(expectedDocs);
+    if (!expected.isEmpty()) {
+      assertEquals(expected, querySnapshotToIds(docsFromQuery));
+    }
+  }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateField.java

@@ -14,9 +14,13 @@
 
 package com.google.firebase.firestore;
 
+import static com.google.firebase.firestore.pipeline.Expr.field;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.RestrictTo;
+import com.google.firebase.firestore.pipeline.AggregateFunction;
+import com.google.firebase.firestore.pipeline.AggregateWithAlias;
 import java.util.Objects;
 
 /** Represents an aggregation that can be performed by Firestore. */
@@ -61,6 +65,9 @@ public String getOperator() {
     return operator;
   }
 
+  @NonNull
+  abstract AggregateWithAlias toPipeline();
+
   /**
    * Returns true if the given object is equal to this object. Two `AggregateField` objects are
    * considered equal if they have the same operator and operate on the same field.
@@ -195,19 +202,37 @@ public static class CountAggregateField extends AggregateField {
     private CountAggregateField() {
       super(null, "count");
     }
+
+    @NonNull
+    @Override
+    AggregateWithAlias toPipeline() {
+      return AggregateFunction.countAll().alias(getAlias());
+    }
   }
 
   /** Represents a "sum" aggregation that can be performed by Firestore. */
   public static class SumAggregateField extends AggregateField {
     private SumAggregateField(@NonNull FieldPath fieldPath) {
       super(fieldPath, "sum");
     }
+
+    @NonNull
+    @Override
+    AggregateWithAlias toPipeline() {
+      return field(getFieldPath()).sum().alias(getAlias());
+    }
   }
 
   /** Represents an "average" aggregation that can be performed by Firestore. */
   public static class AverageAggregateField extends AggregateField {
     private AverageAggregateField(@NonNull FieldPath fieldPath) {
       super(fieldPath, "average");
     }
+
+    @NonNull
+    @Override
+    AggregateWithAlias toPipeline() {
+      return field(getFieldPath()).avg().alias(getAlias());
+    }
   }
 }

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

@@ -22,6 +22,7 @@
 import android.app.Activity;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
@@ -33,6 +34,7 @@
 import com.google.firebase.firestore.core.UserData.ParsedSetData;
 import com.google.firebase.firestore.core.UserData.ParsedUpdateData;
 import com.google.firebase.firestore.core.ViewSnapshot;
+import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.model.Document;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.ResourcePath;
@@ -57,17 +59,15 @@
  * in test mocks. Subclassing is not supported in production code and new SDK releases may break
  * code that does so.
  */
-public class DocumentReference {
+public final class DocumentReference {
 
   private final DocumentKey key;
 
   private final FirebaseFirestore firestore;
 
   DocumentReference(DocumentKey key, FirebaseFirestore firestore) {
     this.key = checkNotNull(key);
-    // TODO: We should checkNotNull(firestore), but tests are currently cheating
-    // and setting it to null.
-    this.firestore = firestore;
+    this.firestore = checkNotNull(firestore);
   }
 
   /** @hide */
@@ -120,6 +120,15 @@ public String getPath() {
     return key.getPath().canonicalString();
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @NonNull
+  public String getFullPath() {
+    DatabaseId databaseId = firestore.getDatabaseId();
+    return String.format(
+        "projects/%s/databases/%s/documents/%s",
+        databaseId.getProjectId(), databaseId.getDatabaseId(), getPath());
+  }
+
   /**
    * Gets a {@code CollectionReference} instance that refers to the subcollection at the specified
    * path relative to this document.
@@ -564,6 +573,12 @@ public int hashCode() {
     return result;
   }
 
+  @NonNull
+  @Override
+  public String toString() {
+    return "DocumentReference{" + "key=" + key + ", firestore=" + firestore + '}';
+  }
+
   private com.google.firebase.firestore.core.Query asQuery() {
     return com.google.firebase.firestore.core.Query.atPath(key.getPath());
   }

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentSnapshot.java

@@ -555,6 +555,7 @@ public int hashCode() {
     return hash;
   }
 
+  @NonNull
   @Override
   public String toString() {
     return "DocumentSnapshot{" + "key=" + key + ", metadata=" + metadata + ", doc=" + doc + '}';

firebase-firestore/src/main/java/com/google/firebase/firestore/FieldPath.java

@@ -18,6 +18,7 @@
 import static com.google.firebase.firestore.util.Preconditions.checkNotNull;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
 import java.util.Arrays;
 import java.util.List;
 import java.util.regex.Pattern;
@@ -33,15 +34,18 @@ public final class FieldPath {
 
   private final com.google.firebase.firestore.model.FieldPath internalPath;
 
-  private FieldPath(List<String> segments) {
+  private FieldPath(@NonNull List<String> segments) {
     this.internalPath = com.google.firebase.firestore.model.FieldPath.fromSegments(segments);
   }
 
-  private FieldPath(com.google.firebase.firestore.model.FieldPath internalPath) {
+  private FieldPath(@NonNull com.google.firebase.firestore.model.FieldPath internalPath) {
     this.internalPath = internalPath;
   }
 
-  com.google.firebase.firestore.model.FieldPath getInternalPath() {
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @NonNull
+  public com.google.firebase.firestore.model.FieldPath getInternalPath() {
     return internalPath;
   }
 
@@ -78,7 +82,9 @@ public static FieldPath documentId() {
   }
 
   /** Parses a field path string into a {@code FieldPath}, treating dots as separators. */
-  static FieldPath fromDotSeparatedPath(@NonNull String path) {
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @NonNull
+  public static FieldPath fromDotSeparatedPath(@NonNull String path) {
     checkNotNull(path, "Provided field path must not be null.");
     checkArgument(
         !RESERVED.matcher(path).find(), "Use FieldPath.of() for field names containing '~*/[]'.");

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

@@ -850,10 +850,12 @@ <T> T callClient(Function<FirestoreClient, T> call) {
     return clientProvider.call(call);
   }
 
+  @NonNull
   DatabaseId getDatabaseId() {
     return databaseId;
   }
 
+  @NonNull
   UserDataReader getUserDataReader() {
     return userDataReader;
   }
@@ -881,4 +883,15 @@ void validateReference(DocumentReference docRef) {
   static void setClientLanguage(@NonNull String languageToken) {
     FirestoreChannel.setClientLanguage(languageToken);
   }
+
+  /**
+   * Build a new Pipeline
+   *
+   * @return {@code PipelineSource} for this Firestore instance.
+   */
+  @NonNull
+  public PipelineSource pipeline() {
+    clientProvider.ensureConfigured();
+    return new PipelineSource(this);
+  }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/Firestore.kt

@@ -21,7 +21,6 @@ import com.google.firebase.Firebase
 import com.google.firebase.FirebaseApp
 import com.google.firebase.components.Component
 import com.google.firebase.components.ComponentRegistrar
-import com.google.firebase.firestore.*
 import com.google.firebase.firestore.util.Executors.BACKGROUND_EXECUTOR
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.channels.awaitClose