refactor: rename error codes (#805)

* refactor(auth): rename error codes Add prefix to error codes. * refactor(firestore): rename error codes Add prefix to error codes. * refactor(storage): rename error codes Add prefix to error codes. * refactor(storage): rename error codes Run format script. * refactor(storage): rename error codes Generate changeset. * docs: add breaking changes * docs [skip ci] --------- Co-authored-by: Robin Genz <[email protected]>
capawesome-team · Jan 26, 2025 · 5c70cf9 · 5c70cf9
1 parent 008fbae
commit 5c70cf9
Show file tree

Hide file tree

Showing 12 changed files with 51 additions and 16 deletions.
diff --git a/.changeset/breezy-hounds-chew.md b/.changeset/breezy-hounds-chew.md
@@ -0,0 +1,6 @@
+---
+'@capacitor-firebase/authentication': major
+'@capacitor-firebase/firestore': major
+---
+
+refactor: add prefix to error codes on Android and iOS to be consistent with the Firebase Web SDK
diff --git a/packages/authentication/BREAKING.md b/packages/authentication/BREAKING.md
@@ -20,6 +20,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 On **Android**, the `accessToken` and `serverAuthCode` are now only requested when the `scopes` option is set.
 
+### Error codes
+
+Error codes are now prefixed with `auth/` to be consistent with the Firebase Web SDK.
+
 ## Version 6.x.x
 
 ### Dependencies

diff --git a/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationHelper.java b/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationHelper.java
@@ -1,5 +1,7 @@
 package io.capawesome.capacitorjs.plugins.firebase.authentication;
 
+import static io.capawesome.capacitorjs.plugins.firebase.authentication.FirebaseAuthenticationPlugin.ERROR_CODE_PREFIX;
+
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
@@ -68,7 +70,8 @@ public static String createErrorCode(@Nullable Exception exception) {
         } else if (exception instanceof FirebaseAuthException) {
             String errorCode = ((FirebaseAuthException) exception).getErrorCode();
             errorCode = errorCode.replaceFirst("ERROR_", "");
-            return snakeToKebabCase(errorCode);
+            String prefixedErrorCode = String.format("%s/%s", ERROR_CODE_PREFIX, errorCode);
+            return snakeToKebabCase(prefixedErrorCode);
         }
         return null;
     }

diff --git a/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationPlugin.java b/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationPlugin.java
@@ -31,6 +31,7 @@
 public class FirebaseAuthenticationPlugin extends Plugin {
 
     public static final String TAG = "FirebaseAuthentication";
+    public static final String ERROR_CODE_PREFIX = "auth";
     public static final String PHONE_VERIFICATION_COMPLETED_EVENT = "phoneVerificationCompleted";
     public static final String PHONE_VERIFICATION_FAILED_EVENT = "phoneVerificationFailed";
     public static final String PHONE_CODE_SENT_EVENT = "phoneCodeSent";

diff --git a/packages/authentication/ios/Plugin/FirebaseAuthenticationHelper.swift b/packages/authentication/ios/Plugin/FirebaseAuthenticationHelper.swift
@@ -51,7 +51,12 @@ public class FirebaseAuthenticationHelper {
 
     public static func createErrorCode(error: Error?) -> String? {
         if let error = error as NSError? {
-            return convertErrorCodeToString(errorCode: error.code)
+            if let errorCode = convertErrorCodeToString(errorCode: error.code) {
+                let prefixedErrorCode = "auth/" + errorCode
+                return prefixedErrorCode
+            } else {
+                return nil
+            }
         }
         return nil
     }

diff --git a/packages/firestore/BREAKING.md b/packages/firestore/BREAKING.md
@@ -4,8 +4,15 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 ## Versions
 
+- [Version 7.x.x](#version-7xx)
 - [Version 6.x.x](#version-6xx)
 
+## Version 7.x.x
+
+### Error codes
+
+Error codes are now prefixed with `firestore/` to be consistent with the Firebase Web SDK.
+
 ## Version 6.x.x
 
 ### Dependencies

diff --git a/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestoreHelper.java b/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestoreHelper.java
@@ -1,5 +1,7 @@
 package io.capawesome.capacitorjs.plugins.firebase.firestore;
 
+import static io.capawesome.capacitorjs.plugins.firebase.firestore.FirebaseFirestorePlugin.ERROR_CODE_PREFIX;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSArray;
@@ -142,7 +144,8 @@ public static String createErrorCode(@Nullable Exception exception) {
             return null;
         } else if (exception instanceof FirebaseFirestoreException) {
             String errorCode = ((FirebaseFirestoreException) exception).getCode().name();
-            return snakeToKebabCase(errorCode);
+            String prefixedErrorCode = String.format("%s/%s", ERROR_CODE_PREFIX, errorCode);
+            return snakeToKebabCase(prefixedErrorCode);
         }
         return null;
     }

diff --git a/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java b/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java
@@ -33,6 +33,7 @@
 public class FirebaseFirestorePlugin extends Plugin {
 
     public static final String TAG = "FirebaseFirestore";
+    public static final String ERROR_CODE_PREFIX = "firestore";
     public static final String ERROR_REFERENCE_MISSING = "reference must be provided.";
     public static final String ERROR_HOST_MISSING = "host must be provided.";
     public static final String ERROR_CALLBACK_ID_MISSING = "callbackId must be provided.";
@@ -414,14 +415,14 @@ public void success(Result result) {
                 @Override
                 public void error(Exception exception) {
                     Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    call.reject(exception.getMessage(), FirebaseFirestoreHelper.createErrorCode(exception));
                 }
             };
 
             implementation.getCountFromServer(options, callback);
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            call.reject(exception.getMessage(), FirebaseFirestoreHelper.createErrorCode(exception));
         }
     }
 

diff --git a/packages/firestore/ios/Plugin/FirebaseFirestoreHelper.swift b/packages/firestore/ios/Plugin/FirebaseFirestoreHelper.swift
@@ -72,7 +72,12 @@ public class FirebaseFirestoreHelper {
 
     public static func createErrorCode(error: Error?) -> String? {
         if let error = error as NSError? {
-            return convertErrorCodeToString(errorCode: error.code)
+            if let errorCode = convertErrorCodeToString(errorCode: error.code) {
+                let prefixedErrorCode = "firestore/" + errorCode
+                return prefixedErrorCode
+            } else {
+                return nil
+            }
         }
         return nil
     }

diff --git a/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift b/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift
@@ -7,8 +7,8 @@ import Capacitor
  */
 @objc(FirebaseFirestorePlugin)
 public class FirebaseFirestorePlugin: CAPPlugin, CAPBridgedPlugin {
-    public let identifier = "FirebaseFirestorePlugin" 
-    public let jsName = "FirebaseFirestore" 
+    public let identifier = "FirebaseFirestorePlugin"
+    public let jsName = "FirebaseFirestore"
     public let pluginMethods: [CAPPluginMethod] = [
         CAPPluginMethod(name: "addDocument", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setDocument", returnType: CAPPluginReturnPromise),
@@ -25,8 +25,8 @@ public class FirebaseFirestorePlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "addDocumentSnapshotListener", returnType: CAPPluginReturnCallback),
         CAPPluginMethod(name: "addCollectionSnapshotListener", returnType: CAPPluginReturnCallback),
         CAPPluginMethod(name: "addCollectionGroupSnapshotListener", returnType: CAPPluginReturnCallback),
-        CAPPluginMethod(name: "removeSnapshotListener", returnType: CAPPluginReturnPromise),
-    ] 
+        CAPPluginMethod(name: "removeSnapshotListener", returnType: CAPPluginReturnPromise)
+    ]
     public let tag = "FirebaseFirestore"
     public let errorReferenceMissing = "reference must be provided."
     public let errorDataMissing = "data must be provided."
@@ -264,7 +264,7 @@ public class FirebaseFirestorePlugin: CAPPlugin, CAPBridgedPlugin {
         implementation?.getCountFromServer(options, completion: { result, error in
             if let error = error {
                 CAPLog.print("[", self.tag, "] ", error)
-                call.reject(error.localizedDescription)
+                call.reject(error.localizedDescription, FirebaseFirestoreHelper.createErrorCode(error: error))
                 return
             }
             if let result = result?.toJSObject() as? JSObject {

diff --git a/...c/main/java/io/capawesome/capacitorjs/plugins/firebase/storage/FirebaseStoragePlugin.java b/...c/main/java/io/capawesome/capacitorjs/plugins/firebase/storage/FirebaseStoragePlugin.java
@@ -247,7 +247,7 @@ public void useEmulator(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            call.reject(exception.getMessage(), FirebaseStorageHelper.createErrorCode(exception));
         }
     }
 }
diff --git a/packages/storage/ios/Plugin/FirebaseStoragePlugin.swift b/packages/storage/ios/Plugin/FirebaseStoragePlugin.swift
@@ -7,17 +7,17 @@ import Capacitor
  */
 @objc(FirebaseStoragePlugin)
 public class FirebaseStoragePlugin: CAPPlugin, CAPBridgedPlugin {
-    public let identifier = "FirebaseStoragePlugin" 
-    public let jsName = "FirebaseStorage" 
+    public let identifier = "FirebaseStoragePlugin"
+    public let jsName = "FirebaseStorage"
     public let pluginMethods: [CAPPluginMethod] = [
         CAPPluginMethod(name: "deleteFile", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getDownloadUrl", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getMetadata", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "listFiles", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "updateMetadata", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "uploadFile", returnType: CAPPluginReturnCallback),
-        CAPPluginMethod(name: "useEmulator", returnType: CAPPluginReturnPromise),
-    ] 
+        CAPPluginMethod(name: "useEmulator", returnType: CAPPluginReturnPromise)
+    ]
     public let tag = "FirebaseFirestore"
     public let errorPathMissing = "path must be provided."
     public let errorUriMissing = "uri must be provided."