Add comparison operator for Auth::User (#1301)

* Add comparison operator for Auth::User * Change to use is_valid() * Add tests * format_code * Add != operator * add comments * Add documentation * update TODO * format code --------- Co-authored-by: Jon Simantov <jsimantov@google.com>

Author: chkuang-g

auth/src/common.cc

@@ -82,5 +82,14 @@ void PhoneAuthProvider::Listener::OnCodeAutoRetrievalTimeOut(
 ///
 User::User() { auth_data_ = nullptr; }
 
+bool User::operator==(const User& user) const {
+ // This is based on the assumption that there is only one user before
+ // Auth rewrite.
+ // TODO(AuthRewrite): Must change during Auth Rewrite
+ return is_valid() == user.is_valid();
+}
+
+bool User::operator!=(const User& user) const { return !(*this == user); }
+
 } // namespace auth
 } // namespace firebase

auth/src/include/firebase/auth/user.h

@@ -198,6 +198,12 @@ class User : public UserInfoInterface {
  /// Assignment operator.
  User& operator=(const User&);
 
+ /// Equality operator.
+ bool operator==(const User&) const;
+
+ /// Inequality operator.
+ bool operator!=(const User&) const;
+
  ~User();
 
  /// Returns whether this User object represents a valid user. Could be false

auth/tests/user_test.cc

@@ -521,5 +521,55 @@ TEST_F(UserTest, TestGetter) {
  EXPECT_FALSE(firebase_user_->uid().empty());
  EXPECT_TRUE(firebase_user_->photo_url().empty());
 }
+
+TEST_F(UserTest, TestComparisonOperator) {
+ {
+ // Two invalid users
+ User user_invalid1;
+ User user_invalid2;
+ EXPECT_EQ(user_invalid1, user_invalid2);
+ }
+
+ {
+ // A invalid user
+ User user_invalid;
+ EXPECT_NE(&firebase_user_, user_invalid);
+ }
+
+ {
+ // Copied valid user
+ User user_copy(&firebase_user_);
+ EXPECT_EQ(&firebase_user_, user_copy);
+ }
+
+ {
+ // Copied invalid user
+ User user_invalid;
+ User user_invalid_copy(user_invalid);
+ EXPECT_EQ(user_invalid, user_invalid_copy);
+ }
+
+ {
+ // Two copied of current_user()
+ User user1 = firebase_auth_->current_user();
+ User user2 = firebase_auth_->current_user();
+ EXPECT_EQ(user1, user2);
+ }
+
+ {
+ // Two copied of current_user_DEPRECATED()
+ User* user1 = firebase_auth_->current_user_DEPRECATED();
+ User* user2 = firebase_auth_->current_user_DEPRECATED();
+ EXPECT_EQ(&user1, &user2);
+ }
+
+ {
+ // User from deprecated API and new API
+ User* user_deprecated = firebase_auth_->current_user_DEPRECATED();
+ User user_new = firebase_auth_->current_user();
+ EXPECT_EQ(user_deprecated, user_new);
+ }
+}
+
 } // namespace auth
 } // namespace firebase