Remove the deprecated RunTransaction function (#544)

* Remove deprecated RunTransaction.

* Add newline to the end of the file.

* Add release notes.

* run format_code.py

Author: ehsannas

firestore/src/android/firestore_android.cc

@@ -440,25 +440,18 @@ WriteBatch FirestoreInternal::batch() const {
   return WriteBatch(new WriteBatchInternal(mutable_this(), result));
 }
 
-Future<void> FirestoreInternal::RunTransaction(TransactionFunction* update,
-                                               bool is_lambda) {
+Future<void> FirestoreInternal::RunTransaction(
+    std::function<Error(Transaction&, std::string&)> update) {
+  auto* lambda_update = new LambdaTransactionFunction(Move(update));
   Env env = GetEnv();
   Local<Object> transaction_function =
-      TransactionInternal::Create(env, this, update);
+      TransactionInternal::Create(env, this, lambda_update);
   Local<Task> task = env.Call(obj_, kRunTransaction, transaction_function);
 
   if (!env.ok()) return {};
 
-  auto* completion =
-      static_cast<LambdaTransactionFunction*>(is_lambda ? update : nullptr);
   return promises_->NewFuture<void>(env, AsyncFn::kRunTransaction, task,
-                                    completion);
-}
-
-Future<void> FirestoreInternal::RunTransaction(
-    std::function<Error(Transaction&, std::string&)> update) {
-  auto* lambda_update = new LambdaTransactionFunction(Move(update));
-  return RunTransaction(lambda_update, /*is_lambda=*/true);
+                                    lambda_update);
 }
 
 Future<void> FirestoreInternal::DisableNetwork() {

firestore/src/android/firestore_android.h

@@ -29,7 +29,6 @@ namespace firestore {
 class Firestore;
 class ListenerRegistrationInternal;
 class Transaction;
-class TransactionFunction;
 class WriteBatch;
 
 template <typename EnumT>
@@ -93,11 +92,6 @@ class FirestoreInternal {
 
   WriteBatch batch() const;
 
-  // Runs transaction atomically.
-  // TODO(b/191969448): Remove the is_lambda parameter if possible.
-  Future<void> RunTransaction(TransactionFunction* update,
-                              bool is_lambda = false);
-
   Future<void> RunTransaction(
       std::function<Error(Transaction&, std::string&)> update);
 

firestore/src/android/lambda_transaction_function.h

@@ -10,6 +10,7 @@
 #include "app/src/assert.h"
 #include "firestore/src/android/firestore_android.h"
 #include "firestore/src/android/promise_android.h"
+#include "firestore/src/common/transaction_function.h"
 #include "firestore/src/include/firebase/firestore/transaction.h"
 
 namespace firebase {

firestore/src/android/transaction_android.h

@@ -9,6 +9,7 @@
 #include "app/meta/move.h"
 #include "app/src/embedded_file.h"
 #include "firestore/src/android/wrapper.h"
+#include "firestore/src/common/transaction_function.h"
 #include "firestore/src/include/firebase/firestore/document_reference.h"
 #include "firestore/src/include/firebase/firestore/field_value.h"
 #include "firestore/src/include/firebase/firestore/map_field_value.h"

firestore/src/common/firestore.cc

@@ -260,11 +260,6 @@ WriteBatch Firestore::batch() const {
   return internal_->batch();
 }
 
-Future<void> Firestore::RunTransaction(TransactionFunction* update) {
-  if (!internal_) return FailedFuture<void>();
-  return internal_->RunTransaction(update);
-}
-
 Future<void> Firestore::RunTransaction(
     std::function<Error(Transaction&, std::string&)> update) {
   FIREBASE_ASSERT_MESSAGE(update, "invalid update parameter is passed in.");

firestore/src/common/transaction_function.h

@@ -0,0 +1,37 @@
+// Copyright 2021 Google LLC
+
+#ifndef FIREBASE_FIRESTORE_SRC_COMMON_TRANSACTION_FUNCTION_H_
+#define FIREBASE_FIRESTORE_SRC_COMMON_TRANSACTION_FUNCTION_H_
+
+#include <string>
+
+#include "firebase/firestore/firestore_errors.h"
+
+namespace firebase {
+namespace firestore {
+
+class Transaction;
+
+/**
+ * An interface for providing code to be executed within a transaction
+ * context.
+ */
+class TransactionFunction {
+ public:
+  virtual ~TransactionFunction() {}
+
+  /**
+   * Subclass should override this method and put the transaction logic here.
+   *
+   * @param[in] transaction The transaction to run this function with.
+   * @param[out] error_message You can set error message with this parameter.
+   * @return Either Error::kErrorOk if successful or the error code from Error
+   * that most closely matches the failure.
+   */
+  virtual Error Apply(Transaction& transaction, std::string& error_message) = 0;
+};
+
+}  // namespace firestore
+}  // namespace firebase
+
+#endif  // FIREBASE_FIRESTORE_SRC_COMMON_TRANSACTION_FUNCTION_H_

firestore/src/include/firebase/firestore.h

@@ -253,26 +253,6 @@ class Firestore {
   virtual Future<void> RunTransaction(
       std::function<Error(Transaction&, std::string&)> update);
 
-  /**
-   * Executes the given update and then attempts to commit the changes applied
-   * within the transaction. If any document read within the transaction has
-   * changed, the update function will be retried. If it fails to commit after 5
-   * attempts, the transaction will fail.
-   *
-   * @param update The function to execute within the transaction context.
-   * (Ownership is not transferred; you are responsible for making sure that
-   * transaction is valid as long as the Future has not yet completed.)
-   *
-   * @return A Future that will be resolved when the transaction finishes.
-   *
-   * @deprecated This method was originally added to support the STLPort C++
-   * runtime on Android. Firebase support for STLPort has been removed, and
-   * consequently this method is deprecated and will be removed in a future
-   * release.
-   */
-  FIREBASE_DEPRECATED virtual Future<void> RunTransaction(
-      TransactionFunction* update);
-
   /**
    * Sets the log verbosity of all Firestore instances.
    *

firestore/src/include/firebase/firestore/transaction.h

@@ -137,27 +137,6 @@ class Transaction {
   mutable TransactionInternal* internal_ = nullptr;
 };
 
-/**
- * An interface for providing code to be executed within a transaction
- * context.
- *
- * @see Firestore::RunTransaction(TransactionFunction*)
- */
-class TransactionFunction {
- public:
-  virtual ~TransactionFunction() {}
-
-  /**
-   * Subclass should override this method and put the transaction logic here.
-   *
-   * @param[in] transaction The transaction to run this function with.
-   * @param[out] error_message You can set error message with this parameter.
-   * @return Either Error::kErrorOk if successful or the error code from Error
-   * that most closely matches the failure.
-   */
-  virtual Error Apply(Transaction& transaction, std::string& error_message) = 0;
-};
-
 }  // namespace firestore
 }  // namespace firebase
 

firestore/src/main/firestore_main.cc

@@ -151,13 +151,6 @@ WriteBatch FirestoreInternal::batch() const {
   return MakePublic(firestore_core_->GetBatch());
 }
 
-Future<void> FirestoreInternal::RunTransaction(TransactionFunction* update) {
-  return RunTransaction(
-      [update](Transaction& transaction, std::string& error_message) {
-        return update->Apply(transaction, error_message);
-      });
-}
-
 Future<void> FirestoreInternal::RunTransaction(
     std::function<Error(Transaction&, std::string&)> update) {
   auto executor = transaction_executor_;

firestore/src/main/firestore_main.h

@@ -28,7 +28,6 @@ namespace firestore {
 class Firestore;
 class ListenerRegistrationInternal;
 class Transaction;
-class TransactionFunction;
 class WriteBatch;
 
 namespace util {
@@ -69,7 +68,6 @@ class FirestoreInternal {
 
   Future<void> RunTransaction(
       std::function<Error(Transaction&, std::string&)> update);
-  Future<void> RunTransaction(TransactionFunction* update);
 
   Future<void> DisableNetwork();