Remove deprecated cpp auth function (#1772)

* Remove deprecated Auth function from C++ SDK

Matching a change made in the Unity SDK, this commit removes:
- Auth: `User::UpdateEmail` and `User::UpdateEmailLastResult`

Updated the release notes to reflect this change.

* Remove deprecated User::UpdateEmail from C++ SDK and tests

Matching a change made in the Unity SDK, this commit removes:
- Auth: `User::UpdateEmail` and `User::UpdateEmailLastResult` methods.

Integration tests in `ta/auth/it/src/integration_test.cc` were updated:
- Removed a call to `UpdateEmail` on an invalid user.
- Commented out calls to `UpdateEmail` in `TestUpdateEmailAndPassword` to allow build to pass. Further work is needed to update this test to the new email verification flow.

Updated the release notes to reflect this change.

* Remove deprecated User::UpdateEmail from C++ SDK and tests

Matching a change made in the Unity SDK, this commit removes:
- Auth: `User::UpdateEmail` and `User::UpdateEmailLastResult` methods.

Integration tests in `ta/auth/it/src/integration_test.cc` were updated:
- Removed a call to `UpdateEmail` on an invalid user.
- Removed commented-out calls to `UpdateEmail` in `TestUpdateEmailAndPassword`.

Updated the release notes to reflect this change.

* I will remove the deprecated `User::UpdateEmail` from the C++ SDK and all tests.

To match a change made in the Unity SDK, I will remove:
- Auth: `User::UpdateEmail` and `User::UpdateEmailLastResult` methods.

I will also remove all usages of the deprecated method from the
integration tests (`auth/integration_test/src/integration_test.cc`) and
unit tests (`auth/tests/user_test.cc` and
`auth/tests/desktop/user_desktop_test.cc`).

I will then update the release notes to reflect this change.

* Restore removal.

* Restore the readme change.

* Format code.

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

Author: jonsimantov

auth/integration_test/src/integration_test.cc

@@ -580,11 +580,6 @@ TEST_F(FirebaseAuthTest, TestOperationsOnInvalidUser) {
   WaitForCompletionOrInvalidStatus(string_future, "GetToken");
   EXPECT_NE(string_future.error(), firebase::auth::kAuthErrorNone);
 
-  LogDebug("Update Email");
-  void_future = invalid_user.UpdateEmail(GenerateEmailAddress().c_str());
-  WaitForCompletionOrInvalidStatus(void_future, "UpdateEmail");
-  EXPECT_NE(void_future.error(), firebase::auth::kAuthErrorNone);
-
   LogDebug("Update Password");
   void_future = invalid_user.UpdatePassword(kTestPassword);
   WaitForCompletionOrInvalidStatus(void_future, "UpdatePassword");
@@ -766,18 +761,13 @@ TEST_F(FirebaseAuthTest, TestUpdateEmailAndPassword) {
   firebase::auth::User user = auth_->current_user();
   EXPECT_TRUE(user.is_valid());
 
-  // Update the user's email and password.
-  const std::string new_email = "new_" + email;
-  WaitForCompletion(user.UpdateEmail(new_email.c_str()), "UpdateEmail");
+  // Update the user's password.
+  // Email update functionality has been changed and the old UpdateEmail method
+  // removed. A more comprehensive test for the new email update flow
+  // (SendEmailVerificationBeforeUpdatingEmail) would be needed here.
   WaitForCompletion(user.UpdatePassword(kTestPasswordUpdated),
                     "UpdatePassword");
 
-  firebase::auth::Credential new_email_cred =
-      firebase::auth::EmailAuthProvider::GetCredential(new_email.c_str(),
-                                                       kTestPasswordUpdated);
-  WaitForCompletion(user.Reauthenticate(new_email_cred), "Reauthenticate");
-  EXPECT_TRUE(user.is_valid());
-
   WaitForCompletion(user.SendEmailVerification(), "SendEmailVerification");
   DeleteUser();
 }

auth/src/android/user_android.cc

@@ -41,8 +41,6 @@ METHOD_LOOKUP_DEFINITION(tokenresult,
     X(IsAnonymous, "isAnonymous", "()Z"),                                      \
     X(Token, "getIdToken", "(Z)Lcom/google/android/gms/tasks/Task;"),          \
     X(ProviderData, "getProviderData", "()Ljava/util/List;"),                  \
-    X(UpdateEmail, "updateEmail", "(Ljava/lang/String;)"                       \
-      "Lcom/google/android/gms/tasks/Task;"),                                  \
     X(VerifyBeforeUpdateEmail, "verifyBeforeUpdateEmail",                      \
       "(Ljava/lang/String;)Lcom/google/android/gms/tasks/Task;"),              \
     X(UpdatePassword, "updatePassword", "(Ljava/lang/String;)"                 \
@@ -353,26 +351,6 @@ std::vector<UserInfoInterface> User::provider_data() const {
   return provider_data;
 }
 
-Future<void> User::UpdateEmail(const char* email) {
-  if (!ValidUser(auth_data_)) {
-    return Future<void>();
-  }
-  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
-  const auto handle = futures.SafeAlloc<void>(kUserFn_UpdateEmail);
-  JNIEnv* env = Env(auth_data_);
-
-  jstring j_email = env->NewStringUTF(email);
-  jobject pending_result = env->CallObjectMethod(
-      UserImpl(auth_data_), user::GetMethodId(user::kUpdateEmail), j_email);
-  env->DeleteLocalRef(j_email);
-
-  if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
-    RegisterCallback(pending_result, handle, auth_data_, nullptr);
-    env->DeleteLocalRef(pending_result);
-  }
-  return MakeFuture(&futures, handle);
-}
-
 Future<void> User::UpdatePassword(const char* password) {
   if (!ValidUser(auth_data_)) {
     return Future<void>();

auth/src/desktop/user_desktop.cc

@@ -835,34 +835,6 @@ Future<void> User::Reload() {
                                  callback);
 }
 
-Future<void> User::UpdateEmail(const char* const email) {
-  if (auth_data_ == nullptr) {  // user is not valid
-    return Future<void>();      // invalid future
-  }
-  Promise<void> promise(&auth_data_->future_impl, kUserFn_UpdateEmail);
-  if (!ValidateCurrentUser(&promise, auth_data_)) {
-    return promise.LastResult();
-  }
-  if (!ValidateEmail(&promise, email)) {
-    return promise.LastResult();
-  }
-  if (!ValidateCurrentUser(&promise, auth_data_)) {
-    return promise.LastResult();
-  }
-
-  const char* language_code = nullptr;
-  auto auth_impl = static_cast<AuthImpl*>(auth_data_->auth_impl);
-  if (!auth_impl->language_code.empty()) {
-    language_code = auth_impl->language_code.c_str();
-  }
-
-  typedef SetAccountInfoRequest RequestT;
-  auto request = RequestT::CreateUpdateEmailRequest(
-      *auth_data_->app, GetApiKey(*auth_data_), email);
-  return CallAsyncWithFreshToken(auth_data_, promise, std::move(request),
-                                 PerformSetAccountInfoFlow<void>);
-}
-
 Future<void> User::UpdatePassword(const char* const password) {
   if (auth_data_ == nullptr) {  // user is not valid
     return Future<void>();      // invalid future

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

@@ -229,20 +229,6 @@ class User : public UserInfoInterface {
   /// </SWIG>
   std::vector<UserInfoInterface> provider_data() const;
 
-  /// @deprecated This is a deprecated method. Please use
-  /// SendEmailVerificationBeforeUpdatingEmail(email) instead.
-  ///
-  /// Sets the email address for the user.
-  ///
-  /// May fail if there is already an email/password-based account for the same
-  /// email address.
-  FIREBASE_DEPRECATED Future<void> UpdateEmail(const char* email);
-
-  /// @deprecated
-  ///
-  /// Get results of the most recent call to UpdateEmail.
-  FIREBASE_DEPRECATED Future<void> UpdateEmailLastResult() const;
-
   /// Attempts to change the password for the current user.
   ///
   /// For an account linked to an Identity Provider (IDP) with no password,

auth/src/ios/user_ios.mm

@@ -102,20 +102,6 @@ explicit IOSWrappedUserInfo(id<FIRUserInfo> user_info) : user_info_(user_info) {
   return provider_data;
 }
 
-Future<void> User::UpdateEmail(const char *email) {
-  if (!ValidUser(auth_data_)) {
-    return Future<void>();
-  }
-  ReferenceCountedFutureImpl &futures = auth_data_->future_impl;
-  const auto handle = futures.SafeAlloc<void>(kUserFn_UpdateEmail);
-  [UserImpl(auth_data_) updateEmail:@(email)
-                         completion:^(NSError *_Nullable error) {
-                           futures.Complete(handle, AuthErrorFromNSError(error),
-                                            [error.localizedDescription UTF8String]);
-                         }];
-  return MakeFuture(&futures, handle);
-}
-
 Future<void> User::UpdatePassword(const char *password) {
   if (!ValidUser(auth_data_)) {
     return Future<void>();

auth/src/user.cc

@@ -20,7 +20,6 @@ namespace firebase {
 namespace auth {
 
 AUTH_RESULT_FN(User, GetToken, std::string)
-AUTH_RESULT_FN(User, UpdateEmail, void)
 AUTH_RESULT_FN(User, UpdatePassword, void)
 AUTH_RESULT_FN(User, LinkWithCredential, AuthResult)
 AUTH_RESULT_FN(User, Reauthenticate, void)

auth/tests/desktop/user_desktop_test.cc

@@ -436,23 +436,6 @@ TEST_F(UserDesktopTest, TestReload) {
   VerifyProviderData(firebase_user_);
 }
 
-// Tests the happy case of setting a new email on the currently logged in user.
-TEST_F(UserDesktopTest, TestUpdateEmail) {
-  InitializeConfigWithAFake(GetUrlForApi(API_KEY, "setAccountInfo"),
-                            FakeSetAccountInfoResponse());
-
-  // SetAccountInfoResponse contains a new token.
-  id_token_listener.ExpectChanges(1);
-  auth_state_listener.ExpectChanges(0);
-
-  const std::string new_email = "new_fake_email@example.com";
-
-  EXPECT_NE(new_email, firebase_user_.email());
-  WaitForFuture(firebase_user_.UpdateEmail(new_email.c_str()));
-  EXPECT_EQ(new_email, firebase_user_.email());
-  VerifyProviderData(firebase_user_);
-}
-
 // Tests the happy case of setting a new password on the currently logged in
 // user.
 TEST_F(UserDesktopTest, TestUpdatePassword) {
@@ -815,16 +798,6 @@ TEST_F(UserDesktopTestSignOutOnError, Reload) {
   sem_.Wait();
 }
 
-TEST_F(UserDesktopTestSignOutOnError, UpdateEmail) {
-  CheckSignOutIfUserIsInvalid(
-      GetUrlForApi(API_KEY, "setAccountInfo"), "USER_NOT_FOUND",
-      kAuthErrorUserNotFound, [&] {
-        sem_.Post();
-        return firebase_user_.UpdateEmail("fake_email@example.com");
-      });
-  sem_.Wait();
-}
-
 TEST_F(UserDesktopTestSignOutOnError, UpdatePassword) {
   CheckSignOutIfUserIsInvalid(
       GetUrlForApi(API_KEY, "setAccountInfo"), "USER_DISABLED",
@@ -881,30 +854,6 @@ TEST_F(UserDesktopTestSignOutOnError, GetToken) {
   sem_.Wait();
 }
 
-// This test is to expose potential race condition and is primarily intended to
-// be run with --config=tsan
-TEST_F(UserDesktopTest, TestRaceCondition_SetAccountInfoAndSignOut) {
-  InitializeConfigWithAFake(GetUrlForApi(API_KEY, "setAccountInfo"),
-                            FakeSetAccountInfoResponse());
-
-  // SignOut is engaged on the main thread, whereas UpdateEmail will be executed
-  // on the background thread; consequently, the order in which they are
-  // executed is not defined. Nevertheless, this should not lead to any data
-  // corruption, when UpdateEmail writes to user profile while it's being
-  // deleted by SignOut. Whichever method succeeds first, user must be signed
-  // out once both are finished: if SignOut finishes last, it overrides the
-  // updated user, and if UpdateEmail finishes last, it should note that there
-  // is no currently signed in user and fail with kAuthErrorUserNotFound.
-
-  auto future = firebase_user_.UpdateEmail("some_email");
-  firebase_auth_->SignOut();
-  while (future.status() == firebase::kFutureStatusPending) {
-  }
-
-  EXPECT_THAT(future.error(), AnyOf(kAuthErrorNone, kAuthErrorNoSignedInUser));
-  EXPECT_FALSE(firebase_auth_->current_user().is_valid());
-}
-
 // LinkWithProvider tests.
 TEST_F(UserDesktopTest, TestLinkWithProviderReturnsUnsupportedError) {
   FederatedOAuthProvider provider;

auth/tests/user_test.cc

@@ -258,36 +258,6 @@ TEST_F(UserTest, TestGetProviderData) {
   EXPECT_TRUE(provider.empty());
 }
 
-TEST_F(UserTest, TestUpdateEmail) {
-  const std::string config =
-      std::string(
-          "{"
-          "  config:["
-          "    {fake:'FirebaseUser.updateEmail', futuregeneric:{ticker:1}},"
-          "    {fake:'FIRUser.updateEmail:completion:', futuregeneric:"
-          "{ticker:1}},") +
-      SET_ACCOUNT_INFO_SUCCESSFUL_RESPONSE +
-      "  ]"
-      "}";
-  firebase::testing::cppsdk::ConfigSet(config.c_str());
-
-  EXPECT_NE("new@email.com", firebase_user_.email());
-  Future<void> result = firebase_user_.UpdateEmail("new@email.com");
-
-// Fake Android & iOS implemented the delay. Desktop stub completed immediately.
-#if defined(FIREBASE_ANDROID_FOR_DESKTOP) || FIREBASE_PLATFORM_IOS || \
-    FIREBASE_PLATFORM_TVOS
-  EXPECT_EQ(firebase::kFutureStatusPending, result.status());
-  EXPECT_NE("new@email.com", firebase_user_.email());
-  firebase::testing::cppsdk::TickerElapse();
-#endif  // defined(FIREBASE_ANDROID_FOR_DESKTOP) || FIREBASE_PLATFORM_IOS ||
-        // FIREBASE_PLATFORM_TVOS
-  MaybeWaitForFuture(result);
-  EXPECT_EQ(firebase::kFutureStatusComplete, result.status());
-  EXPECT_EQ(0, result.error());
-  EXPECT_EQ("new@email.com", firebase_user_.email());
-}
-
 TEST_F(UserTest, TestUpdatePassword) {
   const std::string config =
       std::string(

release_build_files/readme.md

@@ -677,6 +677,7 @@ code.
 ## Release Notes
 ### Upcoming Release
 -   Changes
+    - Auth: Removed deprecated `User::UpdateEmail` method.
     - iOS: Added an option to explicitly specify your app's `AppDelegate` class
       name via the `FirebaseAppDelegateClassName` key in `Info.plist`. This
       provides a more direct way for Firebase to interact with your specified