refactor: use getMessage instead of getLocalizedMessage on Android (

#357)
capawesome-team · Apr 8, 2023 · fe89573 · fe89573
1 parent a79df0b
commit fe89573
Show file tree

Hide file tree

Showing 22 changed files with 158 additions and 98 deletions.
diff --git a/.changeset/dull-keys-remain.md b/.changeset/dull-keys-remain.md
@@ -0,0 +1,12 @@
+---
+"@capacitor-firebase/analytics": major
+"@capacitor-firebase/app": major
+"@capacitor-firebase/app-check": major
+"@capacitor-firebase/authentication": major
+"@capacitor-firebase/crashlytics": major
+"@capacitor-firebase/messaging": major
+"@capacitor-firebase/performance": major
+"@capacitor-firebase/remote-config": major
+---
+
+refactor(android): use `getMessage` instead of `getLocalizedMessage`
diff --git a/packages/analytics/BREAKING.md b/packages/analytics/BREAKING.md
@@ -19,6 +19,12 @@ If you want to use this plugin with Capacitor 4, please install version `1.4.0`:
 npm i @capacitor-firebase/analytics@1.4.0
 ```
 
+### Localized error messages
+
+On Android, error messages were previously generated with `getLocalizedMessage`. They are no longer localized and are generated with `getMessage` instead.
+
+You should therefore check your error handling.
+
 ## Version 1.x.x
 
 ### Capacitor 4

diff --git a/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/analytics/FirebaseAnalytics.java b/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/analytics/FirebaseAnalytics.java
@@ -26,7 +26,7 @@ public void getAppInstanceId(@NonNull final GetAppInstanceIdCallback resultCallb
                     if (!task.isSuccessful()) {
                         Exception exception = task.getException();
                         Log.w(FirebaseAnalyticsPlugin.TAG, "Get AppInstanceId failed.", exception);
-                        resultCallback.error(exception.getLocalizedMessage());
+                        resultCallback.error(exception.getMessage());
                         return;
                     }
 

diff --git a/...in/java/io/capawesome/capacitorjs/plugins/firebase/analytics/FirebaseAnalyticsPlugin.java b/...in/java/io/capawesome/capacitorjs/plugins/firebase/analytics/FirebaseAnalyticsPlugin.java
@@ -44,7 +44,7 @@ public void error(String message) {
             );
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -56,7 +56,7 @@ public void setUserId(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -73,7 +73,7 @@ public void setUserProperty(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -86,7 +86,7 @@ public void setCurrentScreen(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -103,7 +103,7 @@ public void logEvent(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -115,7 +115,7 @@ public void setSessionTimeoutDuration(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -131,7 +131,7 @@ public void setEnabled(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -147,7 +147,7 @@ public void resetAnalyticsData(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 }
diff --git a/packages/app-check/BREAKING.md b/packages/app-check/BREAKING.md
@@ -17,3 +17,9 @@ If you want to use this plugin with Capacitor 4, please install version `1.4.0`:
 ```
 npm i @capacitor-firebase/app-check@1.4.0
 ```
+
+### Localized error messages
+
+On Android, error messages were previously generated with `getLocalizedMessage`. They are no longer localized and are generated with `getMessage` instead.
+
+You should therefore check your error handling.
diff --git a/...d/src/main/java/io/capawesome/capacitorjs/plugins/firebase/appcheck/FirebaseAppCheck.java b/...d/src/main/java/io/capawesome/capacitorjs/plugins/firebase/appcheck/FirebaseAppCheck.java
@@ -22,7 +22,7 @@ public void getToken(boolean forceRefresh, final GetTokenResultCallback resultCa
             .addOnFailureListener(
                 exception -> {
                     Log.w(FirebaseAppCheckPlugin.TAG, "Get App Check token failed.", exception);
-                    resultCallback.error(exception.getLocalizedMessage());
+                    resultCallback.error(exception.getMessage());
                 }
             );
     }

diff --git a/...main/java/io/capawesome/capacitorjs/plugins/firebase/appcheck/FirebaseAppCheckPlugin.java b/...main/java/io/capawesome/capacitorjs/plugins/firebase/appcheck/FirebaseAppCheckPlugin.java
@@ -38,7 +38,7 @@ public void error(String message) {
             );
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -51,7 +51,7 @@ public void initialize(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -67,7 +67,7 @@ public void setTokenAutoRefreshEnabled(PluginCall call) {
             call.resolve();
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 }
diff --git a/packages/app/BREAKING.md b/packages/app/BREAKING.md
@@ -19,6 +19,12 @@ If you want to use this plugin with Capacitor 4, please install version `1.4.0`:
 npm i @capacitor-firebase/app@1.4.0
 ```
 
+### Localized error messages
+
+On Android, error messages were previously generated with `getLocalizedMessage`. They are no longer localized and are generated with `getMessage` instead.
+
+You should therefore check your error handling.
+
 ## Version 1.x.x
 
 ### Capacitor 4

diff --git a/...rc/main/java/io/capawesome/capacitorjs/plugins/firebase/capawesome/FirebaseAppPlugin.java b/...rc/main/java/io/capawesome/capacitorjs/plugins/firebase/capawesome/FirebaseAppPlugin.java
@@ -27,7 +27,7 @@ public void getName(PluginCall call) {
             call.resolve(ret);
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 
@@ -45,7 +45,7 @@ public void getOptions(PluginCall call) {
             call.resolve(ret);
         } catch (Exception exception) {
             Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getLocalizedMessage());
+            call.reject(exception.getMessage());
         }
     }
 }
diff --git a/packages/authentication/BREAKING.md b/packages/authentication/BREAKING.md
@@ -20,6 +20,12 @@ If you want to use this plugin with Capacitor 4, please install version `1.4.0`:
 npm i @capacitor-firebase/authentication@1.4.0
 ```
 
+### Localized error messages
+
+On Android, error messages were previously generated with `getLocalizedMessage`. They are no longer localized and are generated with `getMessage` instead.
+
+You should therefore check your error handling.
+
 ## Version 1.x.x
 
 ### Capacitor 4

diff --git a/...ava/io/capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthentication.java b/...ava/io/capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthentication.java
@@ -158,7 +158,7 @@ public void getIdToken(Boolean forceRefresh, final GetIdTokenResultCallback resu
                     String token = task.getResult().getToken();
                     resultCallback.success(token);
                 } else {
-                    String message = task.getException().getLocalizedMessage();
+                    String message = task.getException().getMessage();
                     resultCallback.error(message);
                 }
             }
@@ -351,7 +351,7 @@ public void signInAnonymously(final PluginCall call) {
                         call.resolve(signInResult);
                     } else {
                         Logger.error(TAG, "signInAnonymously failed.", task.getException());
-                        call.reject(task.getException().getLocalizedMessage());
+                        call.reject(task.getException().getMessage());
                     }
                 }
             );
@@ -649,7 +649,7 @@ public void handleSuccessfulSignIn(
     public void handleFailedSignIn(final PluginCall call, String message, Exception exception) {
         Logger.error(TAG, exception.getMessage(), exception);
         if (message == null && exception != null) {
-            message = exception.getLocalizedMessage();
+            message = exception.getMessage();
         }
         call.reject(message, exception);
     }
@@ -704,7 +704,7 @@ public void handleSuccessfulLink(
     public void handleFailedLink(final PluginCall call, String message, Exception exception) {
         Logger.error(TAG, exception.getMessage(), exception);
         if (message == null && exception != null) {
-            message = exception.getLocalizedMessage();
+            message = exception.getMessage();
         }
         call.reject(message, exception);
     }