Merge pull request #1599 from OneSignal/fix/fcm_correct_types_of_errors_handling

[Fix] FCM register retrying and correct types of errors handling

Author: jkasten2

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSUtils.java

@@ -654,4 +654,17 @@ static boolean shouldLogMissingAppIdError(@Nullable String appId) {
    static int getRandomDelay(int minDelay, int maxDelay) {
       return new Random().nextInt(maxDelay + 1 - minDelay) + minDelay;
    }
+
+   @NonNull
+   static Throwable getRootCauseThrowable(@NonNull Throwable subjectThrowable) {
+      Throwable throwable = subjectThrowable;
+      while (throwable.getCause() != null && throwable.getCause() != throwable) {
+         throwable = throwable.getCause();
+      }
+      return throwable;
+   }
+
+   static String getRootCauseMessage(@NonNull Throwable throwable) {
+      return getRootCauseThrowable(throwable).getMessage();
+   }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/PushRegistratorAbstractGoogle.java

@@ -99,34 +99,60 @@ private boolean attemptRegistration(String senderId, int currentRetry) {
          registeredHandler.complete(registrationId, UserState.PUSH_STATUS_SUBSCRIBED);
          return true;
       } catch (IOException e) {
-         if (!"SERVICE_NOT_AVAILABLE".equals(e.getMessage())) {
-            OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Error Getting " + getProviderName() + " Token", e);
-            if (!firedCallback)
-               registeredHandler.complete(null, UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION);
-            return true;
-         }
-         else {
+         int pushStatus = pushStatusFromThrowable(e);
+         String exceptionMessage = OSUtils.getRootCauseMessage(e);
+         boolean retryingKnownToWorkSometimes =
+             "SERVICE_NOT_AVAILABLE".equals(exceptionMessage) ||
+             "AUTHENTICATION_FAILED".equals(exceptionMessage);
+
+         if (retryingKnownToWorkSometimes) {
+            // Wrapping with new Exception so the current line is included in the stack trace.
+            Exception exception = new Exception(e);
             if (currentRetry >= (REGISTRATION_RETRY_COUNT - 1))
-               OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Retry count of " + REGISTRATION_RETRY_COUNT + " exceed! Could not get a " + getProviderName() + " Token.", e);
+               OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Retry count of " + REGISTRATION_RETRY_COUNT + " exceed! Could not get a " + getProviderName() + " Token.", exception);
             else {
-               OneSignal.Log(OneSignal.LOG_LEVEL.INFO, "'Google Play services' returned SERVICE_NOT_AVAILABLE error. Current retry count: " + currentRetry, e);
+               OneSignal.Log(OneSignal.LOG_LEVEL.INFO, "'Google Play services' returned " + exceptionMessage + " error. Current retry count: " + currentRetry, exception);
                if (currentRetry == 2) {
                   // Retry 3 times before firing a null response and continuing a few more times.
-                  registeredHandler.complete(null, UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_SERVICE_NOT_AVAILABLE);
+                  registeredHandler.complete(null, pushStatus);
                   firedCallback = true;
                   return true;
                }
             }
          }
+         else {
+            // Wrapping with new Exception so the current line is included in the stack trace.
+            Exception exception = new Exception(e);
+            OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Error Getting " + getProviderName() + " Token", exception);
+            if (!firedCallback)
+               registeredHandler.complete(null, pushStatus);
+            return true;
+         }
       } catch (Throwable t) {
-         OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Unknown error getting " + getProviderName() + " Token", t);
-         registeredHandler.complete(null, UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_MISC_EXCEPTION);
+         // Wrapping with new Exception so the current line is included in the stack trace.
+         Exception exception = new Exception(t);
+         int pushStatus = pushStatusFromThrowable(t);
+         OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Unknown error getting " + getProviderName() + " Token", exception);
+         registeredHandler.complete(null, pushStatus);
          return true;
       }
 
       return false;
    }
 
+   static private int pushStatusFromThrowable(Throwable throwable) {
+      String exceptionMessage = OSUtils.getRootCauseMessage(throwable);
+      if (throwable instanceof IOException) {
+         if ("SERVICE_NOT_AVAILABLE".equals(exceptionMessage))
+            return  UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_SERVICE_NOT_AVAILABLE;
+         else if ("AUTHENTICATION_FAILED".equals(exceptionMessage))
+            return UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_AUTHENTICATION_FAILED;
+         else
+            return UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_OTHER;
+      }
+      return UserState.PUSH_STATUS_FIREBASE_FCM_ERROR_MISC_EXCEPTION;
+   }
+
    private boolean isValidProjectNumber(String senderId, PushRegistrator.RegisteredHandler callback) {
       boolean isProjectNumberValidFormat;
       try {

OneSignalSDK/onesignal/src/main/java/com/onesignal/PushRegistratorFCM.java

@@ -103,7 +103,7 @@ String getProviderName() {
 
    @WorkerThread
    @Override
-   String getToken(String senderId) throws ExecutionException, InterruptedException, IOException {
+   String getToken(String senderId) throws Exception {
       initFirebaseApp(senderId);
 
       try {
@@ -151,14 +151,18 @@ private String getTokenWithClassFirebaseInstanceId(String senderId) throws IOExc
    }
 
    @WorkerThread
-   private String getTokenWithClassFirebaseMessaging() throws ExecutionException, InterruptedException {
+   private String getTokenWithClassFirebaseMessaging() throws Exception {
       // We use firebaseApp.get(FirebaseMessaging.class) instead of FirebaseMessaging.getInstance()
       //   as the latter uses the default Firebase app. We need to use a custom Firebase app as
       //   the senderId is provided at runtime.
       FirebaseMessaging fcmInstance = firebaseApp.get(FirebaseMessaging.class);
       // FirebaseMessaging.getToken API was introduced in firebase-messaging:21.0.0
       Task<String> tokenTask = fcmInstance.getToken();
-      return Tasks.await(tokenTask);
+      try {
+         return Tasks.await(tokenTask);
+      } catch (ExecutionException e) {
+         throw tokenTask.getException();
+      }
    }
 
    private void initFirebaseApp(String senderId) {

OneSignalSDK/onesignal/src/main/java/com/onesignal/UserState.java

@@ -40,9 +40,9 @@ abstract class UserState {
     static final int PUSH_STATUS_INVALID_FCM_SENDER_ID = -6;
     static final int PUSH_STATUS_OUTDATED_GOOGLE_PLAY_SERVICES_APP = -7;
     static final int PUSH_STATUS_FIREBASE_FCM_INIT_ERROR = -8;
-    static final int PUSH_STATUS_FIREBASE_FCM_ERROR_SERVICE_NOT_AVAILABLE = -9;
+    static final int PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_SERVICE_NOT_AVAILABLE = -9;
     // -10 is a server side detection only from FCM that the app is no longer installed
-    static final int PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION = -11;
+    static final int PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_OTHER = -11;
     static final int PUSH_STATUS_FIREBASE_FCM_ERROR_MISC_EXCEPTION = -12;
     // -13 to -24 reserved for other platforms
     public static final int PUSH_STATUS_HMS_TOKEN_TIMEOUT = -25;
@@ -51,6 +51,7 @@ abstract class UserState {
     public static final int PUSH_STATUS_HMS_ARGUMENTS_INVALID = -26;
     public static final int PUSH_STATUS_HMS_API_EXCEPTION_OTHER = -27;
     public static final int PUSH_STATUS_MISSING_HMS_PUSHKIT_LIBRARY = -28;
+    public static final int PUSH_STATUS_FIREBASE_FCM_ERROR_IOEXCEPTION_AUTHENTICATION_FAILED = -29;
 
     private static final String[] LOCATION_FIELDS = new String[] { "lat", "long", "loc_acc", "loc_type", "loc_bg", "loc_time_stamp" };
     private static final Set<String> LOCATION_FIELDS_SET = new HashSet<>(Arrays.asList(LOCATION_FIELDS));