operator== and operator!= for QuerySnapshot. (#598)

* operator== and operator!= for QuerySnapshot.

* Address comments.

* Proper test name.

Author: ehsannas

firestore/integration_test_internal/src/query_snapshot_test.cc

@@ -4,6 +4,7 @@
 
 #include "firebase/firestore.h"
 #include "firestore/src/common/wrapper_assertions.h"
+#include "firestore_integration_test.h"
 #if defined(__ANDROID__)
 #include "firestore/src/android/query_snapshot_android.h"
 #endif  // defined(__ANDROID__)
@@ -14,9 +15,9 @@
 namespace firebase {
 namespace firestore {
 
-#if defined(__ANDROID__)
+using QuerySnapshotTest = FirestoreIntegrationTest;
 
-using QuerySnapshotTest = testing::Test;
+#if defined(__ANDROID__)
 
 TEST_F(QuerySnapshotTest, Construction) {
   testutil::AssertWrapperConstructionContract<QuerySnapshot,
@@ -30,5 +31,59 @@ TEST_F(QuerySnapshotTest, Assignment) {
 
 #endif  // defined(__ANDROID__)
 
+TEST_F(QuerySnapshotTest, Equality) {
+  CollectionReference collection =
+      Collection({{"a", {{"k", FieldValue::String("a")}}},
+                  {"b", {{"k", FieldValue::String("b")}}},
+                  {"c", {{"k", FieldValue::String("c")}}}});
+  QuerySnapshot snapshot1 = ReadDocuments(collection.Limit(2));
+  QuerySnapshot snapshot2 = ReadDocuments(collection.Limit(2));
+  QuerySnapshot snapshot3 = ReadDocuments(collection.Limit(1));
+  QuerySnapshot snapshot4 = ReadDocuments(collection);
+  QuerySnapshot snapshot5 =
+      ReadDocuments(collection.OrderBy("k", Query::Direction::kAscending));
+  QuerySnapshot snapshot6 =
+      ReadDocuments(collection.OrderBy("k", Query::Direction::kDescending));
+
+  QuerySnapshot snapshot7 = QuerySnapshot();
+  QuerySnapshot snapshot8 = QuerySnapshot();
+
+  EXPECT_TRUE(snapshot1 == snapshot1);
+  EXPECT_TRUE(snapshot1 == snapshot2);
+  EXPECT_TRUE(snapshot1 != snapshot3);
+  EXPECT_TRUE(snapshot1 != snapshot4);
+  EXPECT_TRUE(snapshot1 != snapshot5);
+  EXPECT_TRUE(snapshot1 != snapshot6);
+  EXPECT_TRUE(snapshot3 != snapshot4);
+  EXPECT_TRUE(snapshot3 != snapshot5);
+  EXPECT_TRUE(snapshot3 != snapshot6);
+  EXPECT_TRUE(snapshot5 != snapshot6);
+  EXPECT_TRUE(snapshot1 != snapshot7);
+  EXPECT_TRUE(snapshot2 != snapshot7);
+  EXPECT_TRUE(snapshot3 != snapshot7);
+  EXPECT_TRUE(snapshot4 != snapshot7);
+  EXPECT_TRUE(snapshot5 != snapshot7);
+  EXPECT_TRUE(snapshot6 != snapshot7);
+  EXPECT_TRUE(snapshot7 == snapshot8);
+
+  EXPECT_FALSE(snapshot1 != snapshot1);
+  EXPECT_FALSE(snapshot1 != snapshot2);
+  EXPECT_FALSE(snapshot1 == snapshot3);
+  EXPECT_FALSE(snapshot1 == snapshot4);
+  EXPECT_FALSE(snapshot1 == snapshot5);
+  EXPECT_FALSE(snapshot1 == snapshot6);
+  EXPECT_FALSE(snapshot3 == snapshot4);
+  EXPECT_FALSE(snapshot3 == snapshot5);
+  EXPECT_FALSE(snapshot3 == snapshot6);
+  EXPECT_FALSE(snapshot5 == snapshot6);
+  EXPECT_FALSE(snapshot1 == snapshot7);
+  EXPECT_FALSE(snapshot2 == snapshot7);
+  EXPECT_FALSE(snapshot3 == snapshot7);
+  EXPECT_FALSE(snapshot4 == snapshot7);
+  EXPECT_FALSE(snapshot5 == snapshot7);
+  EXPECT_FALSE(snapshot6 == snapshot7);
+  EXPECT_FALSE(snapshot7 != snapshot8);
+}
+
 }  // namespace firestore
 }  // namespace firebase

firestore/src/android/query_snapshot_android.cc

@@ -72,5 +72,11 @@ std::size_t QuerySnapshotInternal::size() const {
   return env.Call(obj_, kSize);
 }
 
+bool operator==(const QuerySnapshotInternal& lhs,
+                const QuerySnapshotInternal& rhs) {
+  Env env = FirestoreInternal::GetEnv();
+  return Object::Equals(env, lhs.ToJava(), rhs.ToJava());
+}
+
 }  // namespace firestore
 }  // namespace firebase

firestore/src/android/query_snapshot_android.h

@@ -65,6 +65,14 @@ class QuerySnapshotInternal : public Wrapper {
   std::size_t size() const;
 };
 
+bool operator==(const QuerySnapshotInternal& lhs,
+                const QuerySnapshotInternal& rhs);
+
+inline bool operator!=(const QuerySnapshotInternal& lhs,
+                       const QuerySnapshotInternal& rhs) {
+  return !(lhs == rhs);
+}
+
 }  // namespace firestore
 }  // namespace firebase
 

firestore/src/common/query_snapshot.cc

@@ -103,5 +103,13 @@ std::size_t QuerySnapshot::size() const {
   return internal_->size();
 }
 
+bool operator==(const QuerySnapshot& lhs, const QuerySnapshot& rhs) {
+  if (!lhs.internal_ || !rhs.internal_) {
+    return lhs.internal_ == rhs.internal_;
+  }
+
+  return lhs.internal_ == rhs.internal_ || *lhs.internal_ == *rhs.internal_;
+}
+
 }  // namespace firestore
 }  // namespace firebase

firestore/src/include/firebase/firestore/query_snapshot.h

@@ -164,6 +164,8 @@ class QuerySnapshot {
   bool is_valid() const { return internal_ != nullptr; }
 
  private:
+  friend bool operator==(const QuerySnapshot& lhs, const QuerySnapshot& rhs);
+
   friend class EventListenerInternal;
   friend class FirestoreInternal;
   friend struct ConverterImpl;
@@ -175,6 +177,14 @@ class QuerySnapshot {
   mutable QuerySnapshotInternal* internal_ = nullptr;
 };
 
+/** Checks `lhs` and `rhs` for equality. */
+bool operator==(const QuerySnapshot& lhs, const QuerySnapshot& rhs);
+
+/** Checks `lhs` and `rhs` for inequality. */
+inline bool operator!=(const QuerySnapshot& lhs, const QuerySnapshot& rhs) {
+  return !(lhs == rhs);
+}
+
 }  // namespace firestore
 }  // namespace firebase
 

firestore/src/main/query_snapshot_main.cc

@@ -62,5 +62,10 @@ std::vector<DocumentSnapshot> QuerySnapshotInternal::documents() const {
   return documents_.value();
 }
 
+bool operator==(const QuerySnapshotInternal& lhs,
+                const QuerySnapshotInternal& rhs) {
+  return lhs.snapshot_ == rhs.snapshot_;
+}
+
 }  // namespace firestore
 }  // namespace firebase

firestore/src/main/query_snapshot_main.h

@@ -38,6 +38,9 @@ class QuerySnapshotInternal {
 
   std::vector<DocumentSnapshot> documents() const;
 
+  friend bool operator==(const QuerySnapshotInternal& lhs,
+                         const QuerySnapshotInternal& rhs);
+
  private:
   api::QuerySnapshot snapshot_;
 
@@ -47,6 +50,11 @@ class QuerySnapshotInternal {
   mutable bool changes_include_metadata_ = false;
 };
 
+inline bool operator!=(const QuerySnapshotInternal& lhs,
+                       const QuerySnapshotInternal& rhs) {
+  return !(lhs == rhs);
+}
+
 }  // namespace firestore
 }  // namespace firebase
 

release_build_files/readme.md

@@ -569,8 +569,8 @@ code.
 
 ### 8.4.0
 -   Changes
-    -   Firestore: Added `operator==` and `operator!=` for `SnapshotMetadata`
-        and `Settings`.
+    -   Firestore: Added `operator==` and `operator!=` for `SnapshotMetadata`,
+        `Settings`, and `QuerySnapshot`.
 
 ### 8.3.0
 -   Changes