Skip to content

Add comparison operator for Auth::User #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 3, 2023
Merged

Add comparison operator for Auth::User #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d322844
Add comparison operator for Auth::User
chkuang-g May 2, 2023
049b315
Change to use is_valid()
chkuang-g May 2, 2023
5967293
Add tests
chkuang-g May 2, 2023
7e911b6
format_code
chkuang-g May 2, 2023
7571c5a
Add != operator
chkuang-g May 2, 2023
4991096
add comments
chkuang-g May 2, 2023
a5c75bb
Add documentation
chkuang-g May 2, 2023
0a59a37
update TODO
chkuang-g May 2, 2023
6794a54
format code
chkuang-g May 2, 2023
afdb587
Merge branch 'feature/auth_googleio_23' into feature/auth_compare_user
jonsimantov May 3, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions auth/src/common.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions auth/src/include/firebase/auth/user.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Copy link
Contributor

@jonsimantov jonsimantov May 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix.
Copy link
Contributor Author

@chkuang-g chkuang-g May 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

~User();

/// Returns whether this User object represents a valid user. Could be false
Expand Down
50 changes: 50 additions & 0 deletions auth/tests/user_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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