Auth deprecated methods removal (firebase#1575)

* Remove all deprecated functions and types from headers. * Remove deprecated implementations, and move current_user logic. * Remove deprecated functionality from Android SDK * Remove deprecated functions and types from iOS SDK. * Remove common deprecated code and future Fns. * Remove deprecated tests from integration test. * Remove all deprecated functions and such in desktop. * Remove extraneous methods. * Fix more build issues. * Fix integration test usage of deprecated methods. * Add checks for invalid user to desktop impl. * Format code. * Fix Android build issues. * Add missing method back in. * Fix Doxygen warnings. * Remove deprecated call. * Fix another bad deprecation * Add release notes for removal * Move UpdateEmail back to the right place. * Fix unit tests to refer to non-deprecated methods. * Finish removing AuthCompletionHandle, and fix unit tests more. * Format code. * Fix build error. * Fix more unit test issues. * Format code. * Fix unit test build errors. * Removed deprecated calls in unit tests. * Test build fixes. * Fix typo. * Format code. * Fix a failing test. * Fix user test and pointer usage. * Fix tests.

Author: jonsimantov

auth/integration_test/src/integration_test.cc

@@ -447,26 +447,6 @@ Future<AuthResult> Auth::SignInWithCustomToken(const char* token) {
  return MakeFuture(&futures, handle);
 }
 
-Future<User*> Auth::SignInWithCustomToken_DEPRECATED(const char* token) {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle =
- futures.SafeAlloc<User*>(kAuthFn_SignInWithCustomToken_DEPRECATED);
- JNIEnv* env = Env(auth_data_);
-
- jstring j_token = env->NewStringUTF(token);
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_), auth::GetMethodId(auth::kSignInWithCustomToken),
- j_token);
- env->DeleteLocalRef(j_token);
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_,
- ReadUserFromSignInResult);
- env->DeleteLocalRef(pending_result);
- }
- return MakeFuture(&futures, handle);
-}
-
 Future<User> Auth::SignInWithCredential(const Credential& credential) {
  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
  const auto handle = futures.SafeAlloc<User>(kAuthFn_SignInWithCredential);
@@ -490,31 +470,6 @@ Future<User> Auth::SignInWithCredential(const Credential& credential) {
  return MakeFuture(&futures, handle);
 }
 
-Future<User*> Auth::SignInWithCredential_DEPRECATED(
- const Credential& credential) {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle =
- futures.SafeAlloc<User*>(kAuthFn_SignInWithCredential_DEPRECATED);
- JNIEnv* env = Env(auth_data_);
-
- // If the credential itself is in an error state, don't try signing in.
- if (credential.error_code_ != kAuthErrorNone) {
- futures.Complete(handle, credential.error_code_,
- credential.error_message_.c_str());
- } else {
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_), auth::GetMethodId(auth::kSignInWithCredential),
- CredentialFromImpl(credential.impl_));
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_,
- ReadUserFromSignInResult);
- env->DeleteLocalRef(pending_result);
- }
- }
- return MakeFuture(&futures, handle);
-}
-
 Future<AuthResult> Auth::SignInAndRetrieveDataWithCredential(
  const Credential& credential) {
  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
@@ -539,41 +494,11 @@ Future<AuthResult> Auth::SignInAndRetrieveDataWithCredential(
  return MakeFuture(&futures, handle);
 }
 
-Future<SignInResult> Auth::SignInAndRetrieveDataWithCredential_DEPRECATED(
- const Credential& credential) {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle = futures.SafeAlloc<SignInResult>(
- kAuthFn_SignInAndRetrieveDataWithCredential_DEPRECATED);
- JNIEnv* env = Env(auth_data_);
-
- // If the credential itself is in an error state, don't try signing in.
- if (credential.error_code_ != kAuthErrorNone) {
- futures.Complete(handle, credential.error_code_,
- credential.error_message_.c_str());
- } else {
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_), auth::GetMethodId(auth::kSignInWithCredential),
- CredentialFromImpl(credential.impl_));
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_, ReadSignInResult);
- env->DeleteLocalRef(pending_result);
- }
- }
- return MakeFuture(&futures, handle);
-}
-
 Future<AuthResult> Auth::SignInWithProvider(FederatedAuthProvider* provider) {
  FIREBASE_ASSERT_RETURN(Future<AuthResult>(), provider);
  return provider->SignIn(auth_data_);
 }
 
-Future<SignInResult> Auth::SignInWithProvider_DEPRECATED(
- FederatedAuthProvider* provider) {
- FIREBASE_ASSERT_RETURN(Future<SignInResult>(), provider);
- return provider->SignIn_DEPRECATED(auth_data_);
-}
-
 Future<AuthResult> Auth::SignInAnonymously() {
  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
  const auto handle = futures.SafeAlloc<AuthResult>(kAuthFn_SignInAnonymously);
@@ -590,24 +515,6 @@ Future<AuthResult> Auth::SignInAnonymously() {
  return MakeFuture(&futures, handle);
 }
 
-Future<User*> Auth::SignInAnonymously_DEPRECATED() {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle =
- futures.SafeAlloc<User*>(kAuthFn_SignInAnonymously_DEPRECATED);
- JNIEnv* env = Env(auth_data_);
-
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_), auth::GetMethodId(auth::kSignInAnonymously));
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_,
- ReadUserFromSignInResult);
- env->DeleteLocalRef(pending_result);
- }
-
- return MakeFuture(&futures, handle);
-}
-
 Future<AuthResult> Auth::SignInWithEmailAndPassword(const char* email,
  const char* password) {
  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
@@ -640,39 +547,6 @@ Future<AuthResult> Auth::SignInWithEmailAndPassword(const char* email,
  return MakeFuture(&futures, handle);
 }
 
-Future<User*> Auth::SignInWithEmailAndPassword_DEPRECATED(
- const char* email, const char* password) {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle =
- futures.SafeAlloc<User*>(kAuthFn_SignInWithEmailAndPassword_DEPRECATED);
-
- if (!email || strlen(email) == 0 || !password || strlen(password) == 0) {
- futures.Complete(handle,
- (!email || strlen(email) == 0) ? kAuthErrorMissingEmail
- : kAuthErrorMissingPassword,
- kErrorEmptyEmailPassword);
- return MakeFuture(&futures, handle);
- }
-
- JNIEnv* env = Env(auth_data_);
- jstring j_email = env->NewStringUTF(email);
- jstring j_password = env->NewStringUTF(password);
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_),
- auth::GetMethodId(auth::kSignInWithEmailAndPassword), j_email,
- j_password);
- env->DeleteLocalRef(j_email);
- env->DeleteLocalRef(j_password);
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_,
- ReadUserFromSignInResult);
- env->DeleteLocalRef(pending_result);
- }
-
- return MakeFuture(&futures, handle);
-}
-
 Future<AuthResult> Auth::CreateUserWithEmailAndPassword(const char* email,
  const char* password) {
  ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
@@ -704,52 +578,11 @@ Future<AuthResult> Auth::CreateUserWithEmailAndPassword(const char* email,
  return MakeFuture(&futures, handle);
 }
 
-Future<User*> Auth::CreateUserWithEmailAndPassword_DEPRECATED(
- const char* email, const char* password) {
- ReferenceCountedFutureImpl& futures = auth_data_->future_impl;
- const auto handle = futures.SafeAlloc<User*>(
- kAuthFn_CreateUserWithEmailAndPassword_DEPRECATED);
-
- if (!email || strlen(email) == 0 || !password || strlen(password) == 0) {
- futures.Complete(handle,
- (!email || strlen(email) == 0) ? kAuthErrorMissingEmail
- : kAuthErrorMissingPassword,
- kErrorEmptyEmailPassword);
- return MakeFuture(&futures, handle);
- }
- JNIEnv* env = Env(auth_data_);
-
- jstring j_email = env->NewStringUTF(email);
- jstring j_password = env->NewStringUTF(password);
- jobject pending_result = env->CallObjectMethod(
- AuthImpl(auth_data_),
- auth::GetMethodId(auth::kCreateUserWithEmailAndPassword), j_email,
- j_password);
- env->DeleteLocalRef(j_email);
- env->DeleteLocalRef(j_password);
-
- if (!CheckAndCompleteFutureOnError(env, &futures, handle)) {
- RegisterCallback(pending_result, handle, auth_data_,
- ReadUserFromSignInResult);
- env->DeleteLocalRef(pending_result);
- }
- return MakeFuture(&futures, handle);
-}
-
 User Auth::current_user() {
- User* current_user = current_user_DEPRECATED();
- if (current_user != nullptr) {
- return *current_user;
+ if (!auth_data_) {
+  // Return an invalid user.
+ return User(nullptr);
  }
- // Return an invalid user.
- return User(auth_data_);
-}
-
-// It's safe to return a direct pointer to `current_user` because that class
-// holds nothing but a pointer to AuthData, which never changes.
-// All User functions that require synchronization go through AuthData's mutex.
-User* Auth::current_user_DEPRECATED() {
- if (!auth_data_) return nullptr;
  MutexLock lock(auth_data_->future_impl.mutex());
 
  // auth_data_->current_user should be available after Auth is created because
@@ -758,9 +591,11 @@ User* Auth::current_user_DEPRECATED() {
  // persistent loading. However, it is safe to access auth_data_->current_user
  // here since FirebaseAuth.getCurrentUser() (Android) is called in
  // InitPlatformAuth().
- User* user =
- auth_data_->user_impl == nullptr ? nullptr : &auth_data_->current_user;
- return user;
+ if (auth_data_->user_impl == nullptr) {
+ // return an invalid user.
+ return User(nullptr);
+ }
+ return auth_data_->current_user;
 }
 
 std::string Auth::language_code() const {

auth/src/android/auth_android.cc

@@ -510,42 +510,6 @@ void ReadAuthResult(jobject result, FutureCallbackData<AuthResult>* d,
  }
 }
 
-// The `ReadFutureResultFn` for `SignIn` APIs.
-// Reads the `AuthResult` in `result` and initialize the `User*` in `void_data`.
-void ReadSignInResult(jobject result, FutureCallbackData<SignInResult>* d,
- bool success, void* void_data) {
- JNIEnv* env = Env(d->auth_data);
-
- // Update the currently signed-in user on success.
- // Note: `result` is only valid when success is true.
- if (success && result != nullptr) {
- // `result` is of type AuthResult.
- const jobject j_user = env->CallObjectMethod(
- result, authresult::GetMethodId(authresult::kGetUser));
- util::CheckAndClearJniExceptions(env);
-
- // Update our pointer to the Android FirebaseUser that we're wrapping.
- // Note: Cannot call UpdateCurrentUser(d->auth_data) because the Java
- // Auth class has not been updated at this point.
- SetImplFromLocalRef(env, j_user, &d->auth_data->user_impl);
-
- // Grab the additional user info too.
- // Additional user info is not guaranteed to exist, so could be nullptr.
- const jobject j_additional_user_info = env->CallObjectMethod(
- result, authresult::GetMethodId(authresult::kGetAdditionalUserInfo));
- util::CheckAndClearJniExceptions(env);
-
- // If additional user info exists, assume that the returned data is of
- // type SignInResult (as opposed to just User*).
- SignInResult* sign_in_result = static_cast<SignInResult*>(void_data);
-
- // Return a pointer to the user and gather the additional data.
- sign_in_result->user = d->auth_data->auth->current_user_DEPRECATED();
- ReadAdditionalUserInfo(env, j_additional_user_info, &sign_in_result->info);
- env->DeleteLocalRef(j_additional_user_info);
- }
-}
-
 void ReadUserFromAuthResult(jobject result, FutureCallbackData<User>* d,
  bool success, void* void_data) {
  JNIEnv* env = Env(d->auth_data);
@@ -568,30 +532,5 @@ void ReadUserFromAuthResult(jobject result, FutureCallbackData<User>* d,
  *user_ptr = d->auth_data->auth->current_user();
 }
 
-// The `ReadFutureResultFn` for `SignIn` APIs.
-// Reads the `AuthResult` in `result` and initialize the `User*` in `void_data`.
-void ReadUserFromSignInResult(jobject result, FutureCallbackData<User*>* d,
- bool success, void* void_data) {
- JNIEnv* env = Env(d->auth_data);
-
- // Update the currently signed-in user on success.
- // Note: `result` is only valid when success is true.
- if (success && result != nullptr) {
- // `result` is of type AuthResult.
- const jobject j_user = env->CallObjectMethod(
- result, authresult::GetMethodId(authresult::kGetUser));
- util::CheckAndClearJniExceptions(env);
-
- // Update our pointer to the Android FirebaseUser that we're wrapping.
- // Note: Cannot call UpdateCurrentUser(d->auth_data) because the Java
- // Auth class has not been updated at this point.
- SetImplFromLocalRef(env, j_user, &d->auth_data->user_impl);
- }
-
- // Return a pointer to the current user, if the current user is valid.
- User** user_ptr = static_cast<User**>(void_data);
- *user_ptr = d->auth_data->auth->current_user_DEPRECATED();
-}
-
 } // namespace auth
 } // namespace firebase

auth/src/android/common_android.cc

@@ -91,22 +91,11 @@ struct FutureCallbackData {
 void ReadAuthResult(jobject result, FutureCallbackData<AuthResult>* d,
  bool success, void* void_data);
 
-// The `ReadFutureResultFn` for `SignIn` APIs.
-// Reads the `AuthResult` in `result` and initialize the `User*` in `void_data`.
-void ReadSignInResult(jobject result, FutureCallbackData<SignInResult>* d,
- bool success, void* void_data);
-
 // The `ReadFutureResultFn` for `SignIn` APIs.
 // Reads the `AuthResult` in `result` and initializes the `User` in `void_data`.
 void ReadUserFromAuthResult(jobject result, FutureCallbackData<User>* d,
  bool success, void* void_data);
 
-// The `ReadFutureResultFn` for `SignIn` APIs.
-// Reads the `AuthResult` in `result` and initializes the `User*` in
-// `void_data`.
-void ReadUserFromSignInResult(jobject result, FutureCallbackData<User*>* d,
- bool success, void* void_data);
-
 inline void ReadAdditionalUserInfo(JNIEnv* env, jobject j_additional_user_info,
  AdditionalUserInfo* info) {
  if (j_additional_user_info == nullptr) {