Firestore COUNT API

firestore/src/common/aggregate_query.cc

@@ -48,8 +48,7 @@ AggregateQuery::AggregateQuery(AggregateQuery&& query) {
 
 AggregateQuery::AggregateQuery(AggregateQueryInternal* internal)
     : internal_(internal) {
-  // NOTE: We don't assert internal != nullptr here since internal can be
-  // nullptr when called by the CollectionReference copy constructor.
+  SIMPLE_HARD_ASSERT(internal != nullptr);
   CleanupFnQuery::Register(this, internal_);
 }
 

firestore/src/common/aggregate_query_snapshot.cc

@@ -17,6 +17,7 @@
 #include "firestore/src/include/firebase/firestore/aggregate_query_snapshot.h"
 
 #include "firestore/src/common/cleanup.h"
+#include "firestore/src/common/util.h"
 #include "firestore/src/include/firebase/firestore/aggregate_query.h"
 
 #if defined(__ANDROID__)
@@ -103,5 +104,10 @@ int64_t AggregateQuerySnapshot::count() const {
   return internal_->count();
 }
 
+bool operator==(const AggregateQuerySnapshot& lhs,
+                const AggregateQuerySnapshot& rhs) {
+  return EqualityCompare(lhs.internal_, rhs.internal_);
+}
+
 }  // namespace firestore
 }  // namespace firebase

firestore/src/include/firebase/firestore/aggregate_query.h

@@ -39,8 +39,8 @@ class Query;
 class AggregateQuery {
  public:
   /**
-   * @brief AggregateQuery an invalid Query that has to be reassigned before it
-   * can be used.
+   * @brief Creates an invalid AggregateQuery that has to be reassigned before
+   * it can be used.
    *
    * Calling any member function on an invalid AggregateQuery will be a no-op.
    * If the function returns a value, it will return a zero, empty, or invalid

firestore/src/include/firebase/firestore/aggregate_query_snapshot.h

@@ -27,10 +27,7 @@ class AggregateQuery;
 class AggregateQuerySnapshotInternal;
 
 /**
- * @brief A QuerySnapshot contains zero or more DocumentSnapshot objects.
- *
- * QuerySnapshot can be iterated using a range-based for loop, and its size can
- * be inspected with empty() and size().
+ * @brief The results of executing an AggregateQuery.
  *
  * @note Firestore classes are not meant to be subclassed except for use in test
  * mocks. Subclassing is not supported in production code and new SDK releases
@@ -39,7 +36,7 @@ class AggregateQuerySnapshotInternal;
 class AggregateQuerySnapshot {
  public:
   /**
-   * @brief AggregateQuerySnapshot an invalid Query that has to be reassigned
+   * @brief Creates an invalid AggregateQuerySnapshot that has to be reassigned
    * before it can be used.
    *
    * Calling any member function on an invalid AggregateQuerySnapshot will be a

firestore/src/main/aggregate_query_main.cc

@@ -49,16 +49,15 @@ Query AggregateQueryInternal::query() {
 
 Future<AggregateQuerySnapshot> AggregateQueryInternal::Get(
     AggregateSource source) {
+  auto aggregate_query = aggregate_query_;
   auto promise =
       promise_factory_.CreatePromise<AggregateQuerySnapshot>(AsyncApis::kGet);
-  // TODO(tomandersen) Is there a better way to pass `aggregate_query_` than
-  // through `this`
   aggregate_query_.Get(
-      [this, promise](util::StatusOr<int64_t> maybe_value) mutable {
+      [aggregate_query, promise](util::StatusOr<int64_t> maybe_value) mutable {
         if (maybe_value.ok()) {
           int64_t count = maybe_value.ValueOrDie();
           AggregateQuerySnapshotInternal internal =
-              AggregateQuerySnapshotInternal(aggregate_query_, count);
+              AggregateQuerySnapshotInternal(aggregate_query, count);
           AggregateQuerySnapshot snapshot = MakePublic(std::move(internal));
           promise.SetValue(std::move(snapshot));
         } else {

firestore/src/main/aggregate_query_main.h

@@ -31,7 +31,6 @@ namespace firestore {
 class AggregateQueryInternal {
  public:
   explicit AggregateQueryInternal(api::AggregateQuery&& aggregate_query);
-  ~AggregateQueryInternal() = default;
 
   FirestoreInternal* firestore_internal();
   const FirestoreInternal* firestore_internal() const;

firestore/src/main/aggregate_query_snapshot_main.cc

@@ -23,8 +23,9 @@ namespace firebase {
 namespace firestore {
 
 AggregateQuerySnapshotInternal::AggregateQuerySnapshotInternal(
-    api::AggregateQuery aggregate_query, int64_t count_result)
-    : aggregate_query_(aggregate_query), count_result(count_result) {}
+    api::AggregateQuery&& aggregate_query, int64_t count_result)
+    : aggregate_query_(std::move(aggregate_query)),
+      count_result_(count_result) {}
 
 FirestoreInternal* AggregateQuerySnapshotInternal::firestore_internal() {
   return GetFirestoreInternal(&aggregate_query_.query());
@@ -39,7 +40,15 @@ AggregateQuery AggregateQuerySnapshotInternal::query() const {
   return MakePublic(api::AggregateQuery(aggregate_query_));
 }
 
-int64_t AggregateQuerySnapshotInternal::count() const { return count_result; }
+int64_t AggregateQuerySnapshotInternal::count() const { return count_result_; }
+
+bool operator==(const AggregateQuerySnapshotInternal& lhs,
+                const AggregateQuerySnapshotInternal& rhs) {
+  // TODO(tomandersen) - there needs to be equals operator defined on
+  // api::AggregateQuery
+  return lhs.aggregate_query_.query() == rhs.aggregate_query_.query() &&
+         lhs.count_result_ == rhs.count_result_;
+}
 
 }  // namespace firestore
 }  // namespace firebase

firestore/src/main/aggregate_query_snapshot_main.h

@@ -33,7 +33,7 @@ namespace firestore {
 
 class AggregateQuerySnapshotInternal {
  public:
-  explicit AggregateQuerySnapshotInternal(api::AggregateQuery aggregate_query,
+  explicit AggregateQuerySnapshotInternal(api::AggregateQuery&& aggregate_query,
                                           int64_t count);
 
   FirestoreInternal* firestore_internal();
@@ -47,7 +47,7 @@ class AggregateQuerySnapshotInternal {
 
  private:
   api::AggregateQuery aggregate_query_;
-  int64_t count_result;
+  int64_t count_result_;
 };
 
 inline bool operator!=(const AggregateQuerySnapshotInternal& lhs,

release_build_files/readme.md

@@ -643,7 +643,9 @@ code.
 
 ## Release Notes
 ### Upcoming Release
-    - Firestore: Add Count API.
+-   Changes
+    - Added `Query::Count()`, which fetches the number of documents in the result
+      set without actually downloading the documents ([#1174](https://github.com/firebase/firebase-cpp-sdk/pull/1174)).
 
 ### 10.4.0
 -   Changes