Clean up exception naming

Rename FirebaseFirestoreExceptionInternal to ExceptionInternal.  Rename methods
in ExceptionInternal to better reflect their function.

PiperOrigin-RevId: 334219916

Author: wilhuff

firestore/CMakeLists.txt

@@ -71,14 +71,14 @@ set(android_SRCS
     src/android/document_snapshot_android.h
     src/android/event_listener_android.cc
     src/android/event_listener_android.h
+    src/android/exception_android.cc
+    src/android/exception_android.h
     src/android/field_path_android.cc
     src/android/field_path_android.h
     src/android/field_path_portable.cc
     src/android/field_path_portable.h
     src/android/field_value_android.cc
     src/android/field_value_android.h
-    src/android/firebase_firestore_exception_android.cc
-    src/android/firebase_firestore_exception_android.h
     src/android/firestore_android.cc
     src/android/firestore_android.h
     src/android/geo_point_android.cc

firestore/src/android/event_listener_android.cc

@@ -7,7 +7,7 @@
 #include "app/src/include/firebase/internal/common.h"
 #include "app/src/util_android.h"
 #include "firestore/src/android/document_snapshot_android.h"
-#include "firestore/src/android/firebase_firestore_exception_android.h"
+#include "firestore/src/android/exception_android.h"
 #include "firestore/src/android/query_snapshot_android.h"
 #include "firestore/src/android/util_android.h"
 #include "firestore/src/common/util.h"
@@ -87,10 +87,8 @@ void EventListenerInternal::DocumentEventListenerNativeOnEvent(
       reinterpret_cast<EventListener<DocumentSnapshot>*>(listener_ptr);
   auto* firestore = reinterpret_cast<FirestoreInternal*>(firestore_ptr);
 
-  Error error_code =
-      FirebaseFirestoreExceptionInternal::ToErrorCode(env, error);
-  std::string error_message =
-      FirebaseFirestoreExceptionInternal::ToString(env, error);
+  Error error_code = ExceptionInternal::GetErrorCode(env, error);
+  std::string error_message = ExceptionInternal::ToString(env, error);
   if (error_code != Error::kErrorOk) {
     listener->OnEvent({}, error_code, error_message);
     return;
@@ -113,10 +111,8 @@ void EventListenerInternal::QueryEventListenerNativeOnEvent(JNIEnv* env, jclass,
       reinterpret_cast<EventListener<QuerySnapshot>*>(listener_ptr);
   auto* firestore = reinterpret_cast<FirestoreInternal*>(firestore_ptr);
 
-  Error error_code =
-      FirebaseFirestoreExceptionInternal::ToErrorCode(env, error);
-  std::string error_message =
-      FirebaseFirestoreExceptionInternal::ToString(env, error);
+  Error error_code = ExceptionInternal::GetErrorCode(env, error);
+  std::string error_message = ExceptionInternal::ToString(env, error);
   if (error_code != Error::kErrorOk) {
     listener->OnEvent({}, error_code, error_message);
     return;

firestore/src/android/firebase_firestore_exception_android.cc renamed to firestore/src/android/exception_android.cc

@@ -1,4 +1,4 @@
-#include "firestore/src/android/firebase_firestore_exception_android.h"
+#include "firestore/src/android/exception_android.h"
 
 #include <cstring>
 
@@ -48,8 +48,7 @@ METHOD_LOOKUP_DEFINITION(illegal_state_exception,
                          ILLEGAL_STATE_EXCEPTION_METHODS)
 
 /* static */
-Error FirebaseFirestoreExceptionInternal::ToErrorCode(JNIEnv* env,
-                                                      jobject exception) {
+Error ExceptionInternal::GetErrorCode(JNIEnv* env, jobject exception) {
   if (exception == nullptr) {
     return Error::kErrorOk;
   }
@@ -59,7 +58,7 @@ Error FirebaseFirestoreExceptionInternal::ToErrorCode(JNIEnv* env,
   // code.
   if (env->IsInstanceOf(exception, illegal_state_exception::GetClass())) {
     return Error::kErrorFailedPrecondition;
-  } else if (!IsInstance(env, exception)) {
+  } else if (!IsFirestoreException(env, exception)) {
     return Error::kErrorUnknown;
   }
 
@@ -80,14 +79,13 @@ Error FirebaseFirestoreExceptionInternal::ToErrorCode(JNIEnv* env,
 }
 
 /* static */
-std::string FirebaseFirestoreExceptionInternal::ToString(JNIEnv* env,
-                                                         jobject exception) {
+std::string ExceptionInternal::ToString(JNIEnv* env, jobject exception) {
   return util::GetMessageFromException(env, exception);
 }
 
 /* static */
-jthrowable FirebaseFirestoreExceptionInternal::ToException(
-    JNIEnv* env, Error code, const char* message) {
+jthrowable ExceptionInternal::Create(JNIEnv* env, Error code,
+                                     const char* message) {
   if (code == Error::kErrorOk) {
     return nullptr;
   }
@@ -114,31 +112,29 @@ jthrowable FirebaseFirestoreExceptionInternal::ToException(
 }
 
 /* static */
-jthrowable FirebaseFirestoreExceptionInternal::ToException(
-    JNIEnv* env, jthrowable exception) {
-  if (IsInstance(env, exception)) {
+jthrowable ExceptionInternal::Wrap(JNIEnv* env, jthrowable exception) {
+  if (IsFirestoreException(env, exception)) {
     return static_cast<jthrowable>(env->NewLocalRef(exception));
   } else {
-    return ToException(env, ToErrorCode(env, exception),
-                       ToString(env, exception).c_str());
+    return Create(env, GetErrorCode(env, exception),
+                  ToString(env, exception).c_str());
   }
 }
 
 /* static */
-bool FirebaseFirestoreExceptionInternal::IsInstance(JNIEnv* env,
-                                                    jobject exception) {
+bool ExceptionInternal::IsFirestoreException(JNIEnv* env, jobject exception) {
   return env->IsInstanceOf(exception, firestore_exception::GetClass());
 }
 
 /* static */
-bool FirebaseFirestoreExceptionInternal::IsFirestoreException(
-    JNIEnv* env, jobject exception) {
-  return IsInstance(env, exception) ||
+bool ExceptionInternal::IsAnyExceptionThrownByFirestore(JNIEnv* env,
+                                                        jobject exception) {
+  return IsFirestoreException(env, exception) ||
          env->IsInstanceOf(exception, illegal_state_exception::GetClass());
 }
 
 /* static */
-bool FirebaseFirestoreExceptionInternal::Initialize(App* app) {
+bool ExceptionInternal::Initialize(App* app) {
   JNIEnv* env = app->GetJNIEnv();
   jobject activity = app->activity();
   bool result = firestore_exception::CacheMethodIds(env, activity) &&
@@ -149,7 +145,7 @@ bool FirebaseFirestoreExceptionInternal::Initialize(App* app) {
 }
 
 /* static */
-void FirebaseFirestoreExceptionInternal::Terminate(App* app) {
+void ExceptionInternal::Terminate(App* app) {
   JNIEnv* env = app->GetJNIEnv();
   firestore_exception::ReleaseClass(env);
   firestore_exception_code::ReleaseClass(env);

firestore/src/android/exception_android.h

@@ -0,0 +1,40 @@
+#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_ANDROID_EXCEPTION_ANDROID_H_
+#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_ANDROID_EXCEPTION_ANDROID_H_
+
+#include <string>
+
+#include "app/src/include/firebase/app.h"
+#include "app/src/util_android.h"
+#include "firebase/firestore/firestore_errors.h"
+
+namespace firebase {
+namespace firestore {
+
+class ExceptionInternal {
+ public:
+  static Error GetErrorCode(JNIEnv* env, jobject exception);
+  static std::string ToString(JNIEnv* env, jobject exception);
+
+  static jthrowable Create(JNIEnv* env, Error code, const char* message);
+  static jthrowable Wrap(JNIEnv* env, jthrowable exception);
+
+  /** Returns true if the given object is a FirestoreException. */
+  static bool IsFirestoreException(JNIEnv* env, jobject exception);
+
+  /**
+   * Returns true if the given object is a FirestoreException or any other type
+   * of exception thrown by a Firestore API.
+   */
+  static bool IsAnyExceptionThrownByFirestore(JNIEnv* env, jobject exception);
+
+ private:
+  friend class FirestoreInternal;
+
+  static bool Initialize(App* app);
+  static void Terminate(App* app);
+};
+
+}  // namespace firestore
+}  // namespace firebase
+
+#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_ANDROID_EXCEPTION_ANDROID_H_

firestore/src/android/firebase_firestore_exception_android.h

@@ -17,9 +17,9 @@
 #include "firestore/src/android/document_reference_android.h"
 #include "firestore/src/android/document_snapshot_android.h"
 #include "firestore/src/android/event_listener_android.h"
+#include "firestore/src/android/exception_android.h"
 #include "firestore/src/android/field_path_android.h"
 #include "firestore/src/android/field_value_android.h"
-#include "firestore/src/android/firebase_firestore_exception_android.h"
 #include "firestore/src/android/geo_point_android.h"
 #include "firestore/src/android/lambda_event_listener.h"
 #include "firestore/src/android/lambda_transaction_function.h"
@@ -175,7 +175,7 @@ bool FirestoreInternal::Initialize(App* app) {
 
     if (!(  // Call Initialize on each Firestore internal class.
             FieldValueInternal::Initialize(app) &&
-            FirebaseFirestoreExceptionInternal::Initialize(app) &&
+            ExceptionInternal::Initialize(app) &&
             TransactionInternal::Initialize(app) && Wrapper::Initialize(app) &&
             // Initialize those embedded Firestore internal classes.
             InitializeEmbeddedClasses(app, loader))) {
@@ -242,7 +242,7 @@ void FirestoreInternal::ReleaseClasses(App* app) {
 
   // Call Terminate on each Firestore internal class.
   FieldValueInternal::Terminate(app);
-  FirebaseFirestoreExceptionInternal::Terminate(app);
+  ExceptionInternal::Terminate(app);
   TransactionInternal::Terminate(app);
   Wrapper::Terminate(app);
 }

firestore/src/android/firestore_android.cc

@@ -7,7 +7,7 @@
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util_android.h"
 #include "firestore/src/android/document_snapshot_android.h"
-#include "firestore/src/android/firebase_firestore_exception_android.h"
+#include "firestore/src/android/exception_android.h"
 #include "firestore/src/android/firestore_android.h"
 #include "firestore/src/android/query_snapshot_android.h"
 #include "firestore/src/jni/env.h"
@@ -115,7 +115,7 @@ class Promise {
       switch (result_code) {
         case util::kFutureResultFailure:
           // When failed, result is the exception raised.
-          error_code = FirebaseFirestoreExceptionInternal::ToErrorCode(
+          error_code = ExceptionInternal::GetErrorCode(
               this->firestore_->app()->GetJNIEnv(), result);
           break;
         case util::kFutureResultCancelled:

firestore/src/android/promise_android.h

@@ -8,9 +8,9 @@
 #include "app/src/include/firebase/internal/common.h"
 #include "app/src/util_android.h"
 #include "firestore/src/android/document_reference_android.h"
+#include "firestore/src/android/exception_android.h"
 #include "firestore/src/android/field_path_android.h"
 #include "firestore/src/android/field_value_android.h"
-#include "firestore/src/android/firebase_firestore_exception_android.h"
 #include "firestore/src/android/set_options_android.h"
 #include "firestore/src/jni/env.h"
 #include "firestore/src/jni/hash_map.h"
@@ -114,15 +114,13 @@ DocumentSnapshot TransactionInternal::Get(const DocumentReference& document,
   util::CheckAndClearJniExceptions(env);
   if (exception != nullptr) {
     if (error_code != nullptr) {
-      *error_code =
-          FirebaseFirestoreExceptionInternal::ToErrorCode(env, exception);
+      *error_code = ExceptionInternal::GetErrorCode(env, exception);
     }
     if (error_message != nullptr) {
-      *error_message =
-          FirebaseFirestoreExceptionInternal::ToString(env, exception);
+      *error_message = ExceptionInternal::ToString(env, exception);
     }
 
-    if (!FirebaseFirestoreExceptionInternal::IsInstance(env, exception)) {
+    if (!ExceptionInternal::IsFirestoreException(env, exception)) {
       // We would only preserve exception if it is not
       // FirebaseFirestoreException. The user should decide whether to raise the
       // error or let the transaction succeed.
@@ -163,10 +161,8 @@ void TransactionInternal::PreserveException(jthrowable exception) {
   }
 
   JNIEnv* env = firestore_->app()->GetJNIEnv();
-  if (FirebaseFirestoreExceptionInternal::IsFirestoreException(env,
-                                                               exception)) {
-    jobject firestore_exception =
-        FirebaseFirestoreExceptionInternal::ToException(env, exception);
+  if (ExceptionInternal::IsAnyExceptionThrownByFirestore(env, exception)) {
+    jobject firestore_exception = ExceptionInternal::Wrap(env, exception);
     *first_exception_ =
         static_cast<jthrowable>(env->NewGlobalRef(firestore_exception));
     env->DeleteLocalRef(firestore_exception);
@@ -234,8 +230,7 @@ jobject TransactionInternal::TransactionFunctionNativeApply(
     cpp_transaction.internal_->ClearException();
     return first_exception;
   } else {
-    return FirebaseFirestoreExceptionInternal::ToException(env, code,
-                                                           message.c_str());
+    return ExceptionInternal::Create(env, code, message.c_str());
   }
 }