Merge branch 'mrschmidt/fieldvalue' of github.com:firebase/firebase-cpp-sdk into mrschmidt/fieldvalue

Author: schmidt-sebastian

README.md

@@ -8,6 +8,7 @@ iOS, and desktop platforms. It includes the following Firebase libraries:
 - [Firebase Authentication](https://firebase.google.com/docs/auth/)
 - [Firebase Realtime Database](https://firebase.google.com/docs/database/)
 - [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/)
+- [Cloud Firestore](https://firebase.google.com/docs/firestore/)
 - [Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)
 - [Firebase Invites](https://firebase.google.com/docs/invites/)
 - [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
@@ -65,7 +66,7 @@ required packages:
 The following prerequisites are required when building the libraries for
 desktop platforms.
 
-- [OpenSSL](https://www.openssl.org/), needed for Realtime Database
+- [OpenSSL](https://www.openssl.org/), needed for Realtime Database and Cloud Firestore
 - [Protobuf](https://github.com/protocolbuffers/protobuf/blob/master/src/README.md),
   needed for Remote Config
 
@@ -135,6 +136,7 @@ The CMake following targets are available to build and link with:
 | Firebase Authentication | firebase_auth |
 | Firebase Realtime Database | firebase_database |
 | Firebase Dynamic Links | firebase_dynamic_links |
+| Cloud Firestore | firebase_firestore |
 | Cloud Functions for Firebase | firebase_functions |
 | Firebase Invites | firebase_invites |
 | Firebase Cloud Messaging | firebase_messaging |
@@ -240,6 +242,7 @@ release version of each Firebase library is:
 | Firebase Authentication | :auth:assembleRelease |
 | Firebase Realtime Database | :database:assembleRelease |
 | Firebase Dynamic Links | :dynamic_links:assembleRelease |
+| Cloud Firestore | :firestore:assembleRelease |
 | Cloud Functions for Firebase | :functions:assembleRelease |
 | Firebase Invites | :invites:assembleRelease |
 | Firebase Cloud Messaging | :messaging:assembleRelease |

database/integration_test/src/integration_test.cc

@@ -1266,9 +1266,17 @@ TEST_F(FirebaseDatabaseTest, TestInvalidatingReferencesWhenDeletingApp) {
 
 TEST_F(FirebaseDatabaseTest, TestInfoConnected) {
   SignIn();
+
+  // The entire test can be a bit flaky on iOS, as the iOS SDK's
+  // .info/connected is not quite perfect.
+#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
+  FLAKY_TEST_SECTION_BEGIN();
+#endif  // defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
+
   firebase::database::DatabaseReference ref = CreateWorkingPath();
   // Force getting a value so that we are connected to the database.
   WaitForCompletion(ref.GetValue(), "GetValue 1 [ignored]");
+
   firebase::database::DatabaseReference info =
       database_->GetReference(".info").Child("connected");
   {
@@ -1299,6 +1307,10 @@ TEST_F(FirebaseDatabaseTest, TestInfoConnected) {
     WaitForCompletion(reconnected, "GetValue 5");
     EXPECT_EQ(reconnected.result()->value(), true);
   }
+
+#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
+  FLAKY_TEST_SECTION_END();
+#endif  // defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
 }
 
 TEST_F(FirebaseDatabaseTest, TestGetReferenceWillNullArgument) {

firestore/integration_test_internal/CMakeLists.txt

@@ -95,6 +95,7 @@ set(FIREBASE_INTEGRATION_TEST_PORTABLE_TEST_SRCS
     src/query_test.cc
     src/sanity_test.cc
     src/server_timestamp_test.cc
+    src/settings_test.cc
     src/smoke_test.cc
     src/source_test.cc
     src/transaction_test.cc
@@ -205,6 +206,7 @@ include_directories(${FIREBASE_CPP_SDK_DIR})
 # Additional public headers from Firestore core SDK.
 include_directories(${PROJECT_BINARY_DIR}/bin/external/src/firestore)
 include_directories(${PROJECT_BINARY_DIR}/bin/external/src/nanopb)
+include_directories(${PROJECT_BINARY_DIR}/bin/external/src/firestore/Firestore/Protos/nanopb)
 # Additional public headers for absl.
 include_directories(${ABSEIL_CPP_ROOT})
 # Allow testing internal Firebase APIs.

firestore/integration_test_internal/src/android/settings_android_test.cc

@@ -14,9 +14,9 @@ namespace {
 
 using jni::Env;
 
-using SettingsTest = FirestoreIntegrationTest;
+using SettingsTestAndroid = FirestoreIntegrationTest;
 
-TEST_F(SettingsTest, ConverterBoolsAllTrue) {
+TEST_F(SettingsTestAndroid, ConverterBoolsAllTrue) {
   Env env;
 
   Settings settings;
@@ -34,7 +34,7 @@ TEST_F(SettingsTest, ConverterBoolsAllTrue) {
   EXPECT_EQ(result.cache_size_bytes(), five_mb);
 }
 
-TEST_F(SettingsTest, ConverterBoolsAllFalse) {
+TEST_F(SettingsTestAndroid, ConverterBoolsAllFalse) {
   Env env;
 
   Settings settings;

firestore/integration_test_internal/src/cleanup_test.cc

@@ -43,6 +43,14 @@ void ExpectEqualityToWork(T* ptr) {
   EXPECT_FALSE(*ptr != T());
 }
 
+// Checks that `operator==` and `operator!=` work correctly by comparing to
+// a default-constructed instance.
+template <typename T>
+void ExpectEqualityToWork(const T& ref) {
+  EXPECT_TRUE(ref == T());
+  EXPECT_FALSE(ref != T());
+}
+
 // `ExpectAllMethodsAreNoOps` calls all the public API methods on the given
 // `ptr` and checks that the calls don't crash and, where applicable, return
 // value-initialized values.
@@ -122,8 +130,7 @@ void ExpectAllMethodsAreNoOps(DocumentSnapshot* ptr) {
   EXPECT_FALSE(ptr->exists());
 
   EXPECT_EQ(ptr->reference(), DocumentReference());
-  // TODO(b/137966104): implement == on `SnapshotMetadata`
-  ptr->metadata();
+  ExpectEqualityToWork(ptr->metadata());
 
   EXPECT_EQ(ptr->GetData(), MapFieldValue());
 
@@ -236,8 +243,7 @@ void ExpectAllMethodsAreNoOps(QuerySnapshot* ptr) {
 
   EXPECT_EQ(ptr->query(), Query());
 
-  // TODO(b/137966104): implement == on `SnapshotMetadata`
-  ptr->metadata();
+  ExpectEqualityToWork(ptr->metadata());
 
   EXPECT_TRUE(ptr->DocumentChanges().empty());
   EXPECT_TRUE(ptr->documents().empty());

firestore/integration_test_internal/src/settings_test.cc

@@ -0,0 +1,85 @@
+// Copyright 2021 Google LLC
+
+#include <stdint.h>
+
+#include "firebase/firestore.h"
+
+#include "gtest/gtest.h"
+
+namespace firebase {
+namespace firestore {
+namespace {
+
+TEST(SettingsTest, Equality) {
+  constexpr int64_t kFiveMb = 5 * 1024 * 1024;
+  constexpr int64_t kSixMb = 6 * 1024 * 1024;
+
+  Settings settings1;
+  settings1.set_host("foo");
+  settings1.set_ssl_enabled(true);
+  settings1.set_persistence_enabled(true);
+  settings1.set_cache_size_bytes(kFiveMb);
+
+  Settings settings2;
+  settings2.set_host("bar");
+  settings2.set_ssl_enabled(true);
+  settings2.set_persistence_enabled(true);
+  settings2.set_cache_size_bytes(kFiveMb);
+
+  Settings settings3;
+  settings3.set_host("foo");
+  settings3.set_ssl_enabled(false);
+  settings3.set_persistence_enabled(true);
+  settings3.set_cache_size_bytes(kFiveMb);
+
+  Settings settings4;
+  settings4.set_host("foo");
+  settings4.set_ssl_enabled(true);
+  settings4.set_persistence_enabled(false);
+  settings4.set_cache_size_bytes(kFiveMb);
+
+  Settings settings5;
+  settings5.set_host("foo");
+  settings5.set_ssl_enabled(true);
+  settings5.set_persistence_enabled(true);
+  settings5.set_cache_size_bytes(kSixMb);
+
+  // This is the same as settings4.
+  Settings settings6;
+  settings6.set_host("foo");
+  settings6.set_ssl_enabled(true);
+  settings6.set_persistence_enabled(false);
+  settings6.set_cache_size_bytes(kFiveMb);
+
+  EXPECT_TRUE(settings1 == settings1);
+  EXPECT_TRUE(settings6 == settings4);
+
+  EXPECT_FALSE(settings1 == settings2);
+  EXPECT_FALSE(settings1 == settings3);
+  EXPECT_FALSE(settings1 == settings4);
+  EXPECT_FALSE(settings1 == settings5);
+  EXPECT_FALSE(settings2 == settings3);
+  EXPECT_FALSE(settings2 == settings4);
+  EXPECT_FALSE(settings2 == settings5);
+  EXPECT_FALSE(settings3 == settings4);
+  EXPECT_FALSE(settings3 == settings5);
+  EXPECT_FALSE(settings4 == settings5);
+
+  EXPECT_FALSE(settings1 != settings1);
+  EXPECT_FALSE(settings6 != settings4);
+
+  EXPECT_TRUE(settings1 != settings2);
+  EXPECT_TRUE(settings1 != settings3);
+  EXPECT_TRUE(settings1 != settings4);
+  EXPECT_TRUE(settings1 != settings5);
+  EXPECT_TRUE(settings2 != settings3);
+  EXPECT_TRUE(settings2 != settings4);
+  EXPECT_TRUE(settings2 != settings5);
+  EXPECT_TRUE(settings3 != settings4);
+  EXPECT_TRUE(settings3 != settings5);
+  EXPECT_TRUE(settings4 != settings5);
+}
+
+}  // namespace
+}  // namespace firestore
+}  // namespace firebase

firestore/src/include/firebase/firestore/settings.h

@@ -228,6 +228,19 @@ class Settings final {
 #endif
 };
 
+/** Checks `lhs` and `rhs` for equality. */
+inline bool operator==(const Settings& lhs, const Settings& rhs) {
+  return lhs.host() == rhs.host() &&
+         lhs.is_ssl_enabled() == rhs.is_ssl_enabled() &&
+         lhs.is_persistence_enabled() == rhs.is_persistence_enabled() &&
+         lhs.cache_size_bytes() == rhs.cache_size_bytes();
+}
+
+/** Checks `lhs` and `rhs` for inequality. */
+inline bool operator!=(const Settings& lhs, const Settings& rhs) {
+  return !(lhs == rhs);
+}
+
 }  // namespace firestore
 }  // namespace firebase
 

firestore/src/include/firebase/firestore/snapshot_metadata.h

@@ -140,6 +140,19 @@ class SnapshotMetadata final {
   bool is_from_cache_ = false;
 };
 
+/** Checks `lhs` and `rhs` for equality. */
+inline bool operator==(const SnapshotMetadata& lhs,
+                       const SnapshotMetadata& rhs) {
+  return lhs.has_pending_writes() == rhs.has_pending_writes() &&
+         lhs.is_from_cache() == rhs.is_from_cache();
+}
+
+/** Checks `lhs` and `rhs` for inequality. */
+inline bool operator!=(const SnapshotMetadata& lhs,
+                       const SnapshotMetadata& rhs) {
+  return !(lhs == rhs);
+}
+
 }  // namespace firestore
 }  // namespace firebase
 

release_build_files/readme.md

@@ -570,6 +570,8 @@ code.
 ### 8.4.0
 -   Changes
     -   General: Updating Android and iOS dependencies to the latest.
+    -   Firestore: Added `operator==` and `operator!=` for `SnapshotMetadata`
+        and `Settings`.
 
 ### 8.3.0
 -   Changes

storage/integration_test/src/integration_test.cc

@@ -901,11 +901,14 @@ TEST_F(FirebaseStorageTest, TestInvalidatingReferencesWhenDeletingStorage) {
       CreateFolder().Child("TestFile-InvalidateReferencesDeletingStorage.txt");
   // Don't clean up, will be manually deleted.
 
-  WaitForCompletion(ref.PutBytes(&kSimpleTestFile[0], kSimpleTestFile.size()),
+  WaitForCompletion(RunWithRetry([&]() {
+                      return ref.PutBytes(&kSimpleTestFile[0],
+                                          kSimpleTestFile.size());
+                    }),
                     "PutBytes");
   ASSERT_NE(ref.PutBytesLastResult().result(), nullptr);
   firebase::storage::Metadata metadata = *ref.PutBytesLastResult().result();
-  WaitForCompletion(ref.Delete(), "Delete");
+  WaitForCompletion(RunWithRetry([&]() { return ref.Delete(); }), "Delete");
 
   ASSERT_TRUE(ref.is_valid());
   ASSERT_TRUE(metadata.is_valid());
@@ -924,11 +927,14 @@ TEST_F(FirebaseStorageTest, TestInvalidatingReferencesWhenDeletingApp) {
       CreateFolder().Child("TestFile-InvalidateReferencesDeletingApp.txt");
   // Don't clean up, will be manually deleted.
 
-  WaitForCompletion(ref.PutBytes(&kSimpleTestFile[0], kSimpleTestFile.size()),
+  WaitForCompletion(RunWithRetry([&]() {
+                      return ref.PutBytes(&kSimpleTestFile[0],
+                                          kSimpleTestFile.size());
+                    }),
                     "PutBytes");
   ASSERT_NE(ref.PutBytesLastResult().result(), nullptr);
   firebase::storage::Metadata metadata = *ref.PutBytesLastResult().result();
-  WaitForCompletion(ref.Delete(), "Delete");
+  WaitForCompletion(RunWithRetry([&]() { return ref.Delete(); }), "Delete");
 
   ASSERT_TRUE(ref.is_valid());
   ASSERT_TRUE(metadata.is_valid());