Give clients much more detailed errors

app/src/main/java/com/firebase/uidemo/auth/AuthUiActivity.java

@@ -24,6 +24,7 @@
 import android.support.design.widget.Snackbar;
 import android.support.v7.app.AppCompatActivity;
 import android.support.v7.app.AppCompatDelegate;
+import android.util.Log;
 import android.view.View;
 import android.widget.Button;
 import android.widget.CheckBox;
@@ -49,6 +50,8 @@
 import butterknife.OnClick;
 
 public class AuthUiActivity extends AppCompatActivity {
+    private static final String TAG = "AuthUiActivity";
+
     private static final String GOOGLE_TOS_URL = "https://www.google.com/policies/terms/";
     private static final String FIREBASE_TOS_URL = "https://firebase.google.com/terms/";
     private static final String GOOGLE_PRIVACY_POLICY_URL = "https://www.google.com/policies/privacy/";
@@ -239,7 +242,6 @@ private void handleSignInResponse(int resultCode, Intent data) {
         if (resultCode == RESULT_OK) {
             startSignedInActivity(response);
             finish();
-            return;
         } else {
             // Sign in failed
             if (response == null) {
@@ -248,18 +250,14 @@ private void handleSignInResponse(int resultCode, Intent data) {
                 return;
             }
 
-            if (response.getErrorCode() == ErrorCodes.NO_NETWORK) {
+            if (response.getError().getErrorCode() == ErrorCodes.NO_NETWORK) {
                 showSnackbar(R.string.no_internet_connection);
                 return;
             }
 
-            if (response.getErrorCode() == ErrorCodes.UNKNOWN_ERROR) {
-                showSnackbar(R.string.unknown_error);
-                return;
-            }
+            showSnackbar(R.string.unknown_error);
+            Log.e(TAG, "Sign-in error: ", response.getError());
         }
-
-        showSnackbar(R.string.unknown_sign_in_response);
     }
 
     private void startSignedInActivity(IdpResponse response) {

app/src/main/res/values/strings.xml

@@ -62,7 +62,6 @@
     <string name="require_name">Require first/last name with email accounts.</string>
 
     <string name="unknown_response">Unexpected onActivityResult response code</string>
-    <string name="unknown_sign_in_response">Unknown response from AuthUI sign-in</string>
     <string name="sign_in_cancelled">Sign in cancelled</string>
     <string name="no_internet_connection">No internet connection</string>
     <string name="unknown_error">An unknown error occurred</string>

auth/src/main/java/com/firebase/ui/auth/ErrorCodes.java

@@ -1,20 +1,49 @@
 package com.firebase.ui.auth;
 
+import android.support.annotation.IntDef;
+
+import com.firebase.ui.auth.data.model.FirebaseUiException;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
 /**
- * Error codes retrieved from {@link IdpResponse#getErrorCode()}.
+ * Error codes for failed sign-in attempts.
  */
 public final class ErrorCodes {
     /**
-     * Sign in failed due to lack of network connection
-     **/
-    public static final int NO_NETWORK = 10;
+     * Valid codes that can be returned from {@link FirebaseUiException#getErrorCode()}.
+     */
+    @IntDef({
+                    UNKNOWN_ERROR,
+                    NO_NETWORK,
+                    PLAY_SERVICES_UPDATE_CANCELLED,
+                    DEVELOPER_ERROR
+            })
+    @Retention(RetentionPolicy.SOURCE)
+    public @interface All {}
+
+    /**
+     * An unknown error has occurred.
+     */
+    public static final int UNKNOWN_ERROR = 0;
+
+    /**
+     * Sign in failed due to lack of network connection.
+     */
+    public static final int NO_NETWORK = 1;
+
+    /**
+     * A required update to Play Services was cancelled by the user.
+     */
+    public static final int PLAY_SERVICES_UPDATE_CANCELLED = 2;
 
     /**
-     * An unknown error has occurred
-     **/
-    public static final int UNKNOWN_ERROR = 20;
+     * A sign-in operation couldn't be completed due to a developer error.
+     */
+    public static final int DEVELOPER_ERROR = 3;
 
     private ErrorCodes() {
-        // no instance
+        throw new AssertionError("No instance for you!");
     }
 }

auth/src/main/java/com/firebase/ui/auth/IdpResponse.java

@@ -78,17 +78,17 @@ public static IdpResponse fromResultIntent(@Nullable Intent resultIntent) {
     }
 
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-    public static IdpResponse fromError(@NonNull FirebaseUiException e) {
-        return new IdpResponse(e);
+    public static Intent getErrorIntent(@NonNull Exception e) {
+        return fromError(e).toIntent();
     }
 
-    /**
-     * @deprecated migrate internals to {@link #fromError(FirebaseUiException)}
-     */
-    @Deprecated
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-    public static Intent getErrorCodeIntent(int errorCode) {
-        return new IdpResponse(new FirebaseUiException(errorCode)).toIntent();
+    public static IdpResponse fromError(@NonNull Exception e) {
+        if (e instanceof FirebaseUiException) {
+            return new IdpResponse((FirebaseUiException) e);
+        } else {
+            return new IdpResponse(new FirebaseUiException(ErrorCodes.UNKNOWN_ERROR, e));
+        }
     }
 
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
@@ -149,7 +149,10 @@ public String getIdpSecret() {
 
     /**
      * Get the error code for a failed sign in
+     *
+     * @deprecated use {@link #getError()} instead
      */
+    @Deprecated
     public int getErrorCode() {
         if (isSuccessful()) {
             return Activity.RESULT_OK;
@@ -158,9 +161,11 @@ public int getErrorCode() {
         }
     }
 
+    /**
+     * Get the error for a failed sign in.
+     */
     @Nullable
-    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-    public FirebaseUiException getException() {
+    public FirebaseUiException getError() {
         return mException;
     }
 

auth/src/main/java/com/firebase/ui/auth/KickoffActivity.java

@@ -8,6 +8,7 @@
 import android.support.annotation.RestrictTo;
 import android.util.Log;
 
+import com.firebase.ui.auth.data.model.FirebaseUiException;
 import com.firebase.ui.auth.data.model.FlowParameters;
 import com.firebase.ui.auth.ui.HelperActivityBase;
 import com.firebase.ui.auth.util.ExtraConstants;
@@ -33,8 +34,8 @@ protected void onCreate(Bundle savedInstance) {
         if (savedInstance == null || savedInstance.getBoolean(IS_WAITING_FOR_PLAY_SERVICES)) {
             if (isOffline()) {
                 Log.d(TAG, "No network connection");
-                finish(RESULT_CANCELED,
-                       IdpResponse.getErrorCodeIntent(ErrorCodes.NO_NETWORK));
+                finish(RESULT_CANCELED, IdpResponse.getErrorIntent(
+                        new FirebaseUiException(ErrorCodes.NO_NETWORK)));
                 return;
             }
 
@@ -44,9 +45,8 @@ protected void onCreate(Bundle savedInstance) {
                     new DialogInterface.OnCancelListener() {
                         @Override
                         public void onCancel(DialogInterface dialog) {
-                            finish(RESULT_CANCELED,
-                                   IdpResponse.getErrorCodeIntent(
-                                           ErrorCodes.UNKNOWN_ERROR));
+                            finish(RESULT_CANCELED, IdpResponse.getErrorIntent(
+                                    new FirebaseUiException(ErrorCodes.PLAY_SERVICES_UPDATE_CANCELLED)));
                         }
                     });
 
@@ -73,8 +73,8 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
             if (resultCode == RESULT_OK) {
                 start();
             } else {
-                finish(RESULT_CANCELED,
-                       IdpResponse.getErrorCodeIntent(ErrorCodes.UNKNOWN_ERROR));
+                finish(RESULT_CANCELED, IdpResponse.getErrorIntent(
+                        new FirebaseUiException(ErrorCodes.PLAY_SERVICES_UPDATE_CANCELLED)));
             }
         } else {
             SignInDelegate delegate = SignInDelegate.getInstance(this);

auth/src/main/java/com/firebase/ui/auth/data/model/FirebaseUiException.java

@@ -1,33 +1,46 @@
 package com.firebase.ui.auth.data.model;
 
+import android.support.annotation.NonNull;
 import android.support.annotation.RestrictTo;
 
+import com.firebase.ui.auth.ErrorCodes;
+
 /**
  * Base class for all FirebaseUI exceptions.
  */
-@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 public class FirebaseUiException extends Exception {
     private final int mErrorCode;
 
-    public FirebaseUiException(int code) {
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseUiException(@ErrorCodes.All int code) {
         mErrorCode = code;
     }
 
-    public FirebaseUiException(int code, String message) {
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseUiException(@ErrorCodes.All int code, @NonNull String message) {
         super(message);
         mErrorCode = code;
     }
 
-    public FirebaseUiException(int code, String message, Throwable cause) {
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseUiException(@ErrorCodes.All int code,
+                               @NonNull String message,
+                               @NonNull Throwable cause) {
         super(message, cause);
         mErrorCode = code;
     }
 
-    public FirebaseUiException(int code, Throwable cause) {
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseUiException(@ErrorCodes.All int code, @NonNull Throwable cause) {
         super(cause);
         mErrorCode = code;
     }
 
+    /**
+     * @return error code associated with this exception
+     * @see com.firebase.ui.auth.ErrorCodes
+     */
+    @ErrorCodes.All
     public final int getErrorCode() {
         return mErrorCode;
     }

auth/src/main/java/com/firebase/ui/auth/provider/FacebookProvider.java

@@ -34,8 +34,10 @@
 import com.facebook.login.LoginManager;
 import com.facebook.login.LoginResult;
 import com.firebase.ui.auth.AuthUI;
+import com.firebase.ui.auth.ErrorCodes;
 import com.firebase.ui.auth.IdpResponse;
 import com.firebase.ui.auth.R;
+import com.firebase.ui.auth.data.model.FirebaseUiException;
 import com.firebase.ui.auth.data.model.User;
 import com.firebase.ui.auth.util.ExtraConstants;
 import com.google.firebase.auth.AuthCredential;
@@ -130,12 +132,12 @@ public void onCompleted(JSONObject object, GraphResponse response) {
                         FacebookRequestError requestError = response.getError();
                         if (requestError != null) {
                             Log.e(TAG, "Received Facebook error: " + requestError.getErrorMessage());
-                            onFailure();
+                            onFailure(requestError.getException());
                             return;
                         }
                         if (object == null) {
                             Log.w(TAG, "Received null response from Facebook GraphRequest");
-                            onFailure();
+                            onFailure(new FirebaseUiException(ErrorCodes.UNKNOWN_ERROR));
                         } else {
                             String email = null;
                             String name = null;
@@ -168,13 +170,13 @@ public void onCompleted(JSONObject object, GraphResponse response) {
 
     @Override
     public void onCancel() {
-        onFailure();
+        onFailure(new FirebaseUiException(ErrorCodes.UNKNOWN_ERROR));
     }
 
     @Override
-    public void onError(FacebookException error) {
-        Log.e(TAG, "Error logging in with Facebook. " + error.getMessage());
-        onFailure();
+    public void onError(FacebookException e) {
+        Log.e(TAG, "Error logging in with Facebook. " + e.getMessage());
+        onFailure(e);
     }
 
     private void onSuccess(LoginResult loginResult,
@@ -191,9 +193,9 @@ private void onSuccess(LoginResult loginResult,
                 .build());
     }
 
-    private void onFailure() {
+    private void onFailure(Exception e) {
         gcCallbackManager();
-        mCallbackObject.onFailure();
+        mCallbackObject.onFailure(e);
     }
 
     private void gcCallbackManager() {

auth/src/main/java/com/firebase/ui/auth/provider/GoogleProvider.java

@@ -25,8 +25,10 @@
 import android.widget.Toast;
 
 import com.firebase.ui.auth.AuthUI.IdpConfig;
+import com.firebase.ui.auth.ErrorCodes;
 import com.firebase.ui.auth.IdpResponse;
 import com.firebase.ui.auth.R;
+import com.firebase.ui.auth.data.model.FirebaseUiException;
 import com.firebase.ui.auth.data.model.User;
 import com.firebase.ui.auth.util.ExtraConstants;
 import com.google.android.gms.auth.api.Auth;
@@ -152,7 +154,7 @@ private void onError(GoogleSignInResult result) {
 
     private void onError(String errorMessage) {
         Log.e(TAG, "Error logging in with Google. " + errorMessage);
-        mIdpCallback.onFailure();
+        mIdpCallback.onFailure(new FirebaseUiException(ErrorCodes.UNKNOWN_ERROR, errorMessage));
     }
 }
 

auth/src/main/java/com/firebase/ui/auth/provider/IdpProvider.java

@@ -14,13 +14,15 @@
 
 package com.firebase.ui.auth.provider;
 
+import android.support.annotation.NonNull;
+
 import com.firebase.ui.auth.IdpResponse;
 
 public interface IdpProvider extends Provider {
     interface IdpCallback {
-        void onSuccess(IdpResponse idpResponse);
+        void onSuccess(@NonNull IdpResponse idpResponse);
 
-        void onFailure();
+        void onFailure(@NonNull Exception e);
     }
 
     void setAuthenticationCallback(IdpCallback callback);

auth/src/main/java/com/firebase/ui/auth/provider/TwitterProvider.java

@@ -108,16 +108,16 @@ public void success(Result<User> result) {
                     }
 
                     @Override
-                    public void failure(TwitterException exception) {
-                        mCallbackObject.onFailure();
+                    public void failure(TwitterException e) {
+                        mCallbackObject.onFailure(e);
                     }
                 });
     }
 
     @Override
-    public void failure(TwitterException exception) {
-        Log.e(TAG, "Failure logging in to Twitter. " + exception.getMessage());
-        mCallbackObject.onFailure();
+    public void failure(TwitterException e) {
+        Log.e(TAG, "Failure logging in to Twitter. " + e.getMessage());
+        mCallbackObject.onFailure(e);
     }
 
     private IdpResponse createIdpResponse(TwitterSession session,

auth/src/main/java/com/firebase/ui/auth/ui/idp/AuthMethodPickerActivity.java

@@ -17,6 +17,7 @@
 import android.content.Context;
 import android.content.Intent;
 import android.os.Bundle;
+import android.support.annotation.NonNull;
 import android.support.annotation.RestrictTo;
 import android.support.constraint.ConstraintLayout;
 import android.support.constraint.ConstraintSet;
@@ -160,7 +161,7 @@ public void onActivityResult(int requestCode, int resultCode, Intent data) {
     }
 
     @Override
-    public void onSuccess(final IdpResponse response) {
+    public void onSuccess(@NonNull final IdpResponse response) {
         AuthCredential credential = ProviderUtils.getAuthCredential(response);
         getAuthHelper().getFirebaseAuth()
                 .signInWithCredential(credential)
@@ -180,7 +181,7 @@ public void onSuccess(AuthResult authResult) {
     }
 
     @Override
-    public void onFailure() {
+    public void onFailure(@NonNull Exception e) {
         // stay on this screen
         getDialogHolder().dismissDialog();
     }