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

To align with a recent change in the Unity SDK, I will remove the `User::UpdateEmail` and `User::UpdateEmailLastResult` methods from the authentication functionality.

This will also involve removing all uses of the deprecated method from the integration and unit tests.

Finally, I will update the release notes to reflect this change.

Author: google-labs-jules[bot]

auth/integration_test/src/integration_test.cc

@@ -580,6 +580,11 @@ 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");
@@ -753,25 +758,6 @@ TEST_F(FirebaseAuthTest, TestUpdateUserProfileEmpty) {
   DeleteUser();
 }
 
-TEST_F(FirebaseAuthTest, TestUpdateEmailAndPassword) {
-  std::string email = GenerateEmailAddress();
-  WaitForCompletion(
-      auth_->CreateUserWithEmailAndPassword(email.c_str(), kTestPassword),
-      "CreateUserWithEmailAndPassword");
-  firebase::auth::User user = auth_->current_user();
-  EXPECT_TRUE(user.is_valid());
-
-  // 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");
-
-  WaitForCompletion(user.SendEmailVerification(), "SendEmailVerification");
-  DeleteUser();
-}
-
 TEST_F(FirebaseAuthTest, TestVerifyBeforeUpdatingEmail) {
   std::string email = GenerateEmailAddress();
   WaitForCompletion(

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)

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