Differentiate between user cancellation and actual errors

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

@@ -33,8 +33,9 @@
 
 import com.firebase.ui.auth.AuthUI;
 import com.firebase.ui.auth.AuthUI.IdpConfig;
+import com.firebase.ui.auth.ErrorCodes;
 import com.firebase.ui.auth.IdpResponse;
-import com.firebase.ui.auth.ui.ResultCodes;
+import com.firebase.ui.auth.ResultCodes;
 import com.firebase.uidemo.R;
 import com.google.android.gms.common.Scopes;
 import com.google.firebase.auth.FirebaseAuth;
@@ -199,20 +200,30 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 
     @MainThread
     private void handleSignInResponse(int resultCode, Intent data) {
-        if (resultCode == RESULT_OK) {
-            startActivity(SignedInActivity.createIntent(this, IdpResponse.fromResultIntent(data)));
-            finish();
-            return;
-        }
-
-        if (resultCode == RESULT_CANCELED) {
-            showSnackbar(R.string.sign_in_cancelled);
-            return;
-        }
+        IdpResponse response = IdpResponse.fromResultIntent(data);
 
-        if (resultCode == ResultCodes.RESULT_NO_NETWORK) {
-            showSnackbar(R.string.no_internet_connection);
+        // Successfully signed in
+        if (resultCode == ResultCodes.OK) {
+            startActivity(SignedInActivity.createIntent(this, response));
+            finish();
             return;
+        } else {
+            // Sign in failed
+            if (response == null) {
+                // User pressed back button
+                showSnackbar(R.string.sign_in_cancelled);
+                return;
+            }
+
+            if (response.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_sign_in_response);

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

@@ -65,6 +65,8 @@ public class SignedInActivity extends AppCompatActivity {
     @BindView(R.id.user_enabled_providers)
     TextView mEnabledProviders;
 
+    private IdpResponse mIdpResponse;
+
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -76,6 +78,8 @@ public void onCreate(Bundle savedInstanceState) {
             return;
         }
 
+        mIdpResponse = getIntent().getParcelableExtra(EXTRA_IDP_RESPONSE);
+
         setContentView(R.layout.signed_in_layout);
         ButterKnife.bind(this);
         populateProfile();
@@ -177,10 +181,9 @@ private void populateProfile() {
     }
 
     private void populateIdpToken() {
-        IdpResponse idpResponse = getIntent().getParcelableExtra(EXTRA_IDP_RESPONSE);
-        if (idpResponse != null) {
-            String token = idpResponse.getIdpToken();
-            String secret = idpResponse.getIdpSecret();
+        if (mIdpResponse != null) {
+            String token = mIdpResponse.getIdpToken();
+            String secret = mIdpResponse.getIdpSecret();
             if (token == null) {
                 findViewById(R.id.idp_token_layout).setVisibility(View.GONE);
             } else {

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

@@ -57,6 +57,7 @@
     <string name="photos">Photos</string>
     <string name="idp_token">IDP Token</string>
     <string name="idp_secret">IDP Secret</string>
+    <string name="unknown_error">An unknown error occurred</string>
     <string name="send">Send</string>
     <string name="download">Download</string>
     <string name="upload">Upload</string>

auth/README.md

@@ -216,42 +216,47 @@ startActivityForResult(
 #### Handling the sign-in response
 
 #####Response codes
-The authentication flow only provides three response codes:
-`Activity.RESULT_OK` if a user is signed in, `Activity.RESULT_CANCELLED` if
-sign in failed, and `ResultCodes.RESULT_NO_NETWORK` if sign in failed due to a lack of network connectivity.
-No further information on failure is provided as it is not
-typically useful; the only recourse for most apps if sign in fails is to ask
-the user to sign in again later, or proceed with anonymous sign-in if
-supported.
+The authentication flow provides several response codes of which the most common are as follows:
+`ResultCodes.OK` if a user is signed in, `ResultCodes.CANCELLED` if the user manually canceled the sign in,
+`ResultCodes.NO_NETWORK` if sign in failed due to a lack of network connectivity,
+and `ResultCodes.UNKNOWN_ERROR` for all other errors.
+Typically, the only recourse for most apps if sign in fails is to ask
+the user to sign in again later, or proceed with anonymous sign-in if supported.
 
 ```java
 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     super.onActivityResult(requestCode, resultCode, data);
-    // RC_SIGN_IN is the request code you passed into startActivityForResult(...) when starting the sign in flow
+    // RC_SIGN_IN is the request code you passed into startActivityForResult(...) when starting the sign in flow.
     if (requestCode == RC_SIGN_IN) {
-        if (resultCode == RESULT_OK) {
-            // user is signed in!
-            startActivity(new Intent(this, WelcomeBackActivity.class));
+        IdpResponse response = IdpResponse.fromResultIntent(data);
+
+        // Successfully signed in
+        if (resultCode == ResultCodes.OK) {
+            startActivity(SignedInActivity.createIntent(this, response));
             finish();
             return;
-        }
+        } else {
+            // Sign in failed
+            if (response == null) {
+                // User pressed back button
+                showSnackbar(R.string.sign_in_cancelled);
+                return;
+            }
 
-        // Sign in canceled
-        if (resultCode == RESULT_CANCELED) {
-            showSnackbar(R.string.sign_in_cancelled);
-            return;
-        }
+            if (response.getErrorCode() == ErrorCodes.NO_NETWORK) {
+                showSnackbar(R.string.no_internet_connection);
+                return;
+            }
 
-        // No network
-        if (resultCode == ResultCodes.RESULT_NO_NETWORK) {
-            showSnackbar(R.string.no_internet_connection);
-            return;
+            if (response.getErrorCode() == ErrorCodes.UNKNOWN_ERROR) {
+                showSnackbar(R.string.unknown_error);
+                return;
+            }
         }
 
-        // User is not signed in. Maybe just wait for the user to press
-        // "sign in" again, or show a message.
+        showSnackbar(R.string.unknown_sign_in_response);
     }
-}
+ }
 ```
 
 Alternatively, you can register a listener for authentication state changes;
@@ -266,7 +271,7 @@ Intent.
 ```java
 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     super.onActivityResult(requestCode, resultCode, data);
-    if (resultCode == RESULT_OK) {
+    if (resultCode == ResultCodes.OK) {
         IdpResponse idpResponse = IdpResponse.fromResultIntent(data);
         startActivity(new Intent(this, WelcomeBackActivity.class)
                 .putExtra("my_token", idpResponse.getIdpToken()));

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

@@ -137,8 +137,9 @@
  *
  * <h3>Handling the Sign-in response</h3>
  *
- * The authentication flow provides only two response codes: {@link Activity#RESULT_OK RESULT_OK}
- * if a user is signed in, and {@link Activity#RESULT_CANCELED RESULT_CANCELLED} if sign in
+ * The authentication flow provides only two response codes:
+ * {@link ResultCodes#OK RESULT_OK} if a user is signed in,
+ * and {@link ResultCodes#CANCELED RESULT_CANCELLED} if sign in
  * failed. No further information on failure is provided as it is not typically useful; the only
  * recourse for most apps if sign in fails is to ask the user to sign in again later, or proceed
  * with an anonymous account if supported.
@@ -149,7 +150,7 @@
  * protected void onActivityResult(int requestCode, int resultCode, Intent data) {
  *   super.onActivityResult(requestCode, resultCode, data);
  *   if (requestCode == RC_SIGN_IN) {
- *     if (resultCode == RESULT_OK) {
+ *     if (resultCode == ResultCodes.OK) {
  *       // user is signed in!
  *       startActivity(new Intent(this, WelcomeBackActivity.class));
  *       finish();

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

@@ -0,0 +1,20 @@
+package com.firebase.ui.auth;
+
+/**
+ * Error codes retrieved from {@link IdpResponse#getErrorCode()}.
+ */
+public final class ErrorCodes {
+    private ErrorCodes() {
+        // We don't want people to initialize this class
+    }
+
+    /**
+     * Sign in failed due to lack of network connection
+     **/
+    public static final int NO_NETWORK = 10;
+
+    /**
+     * An unknown error has occurred
+     **/
+    public static final int UNKNOWN_ERROR = 20;
+}

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

@@ -27,16 +27,21 @@
 public class IdpResponse implements Parcelable {
 
     private final String mProviderId;
-    @Nullable private final String mEmail;
+    @Nullable
+    private final String mEmail;
     private final String mToken;
     private final String mSecret;
+    private final int mErrorCode;
+
+    public IdpResponse(int errorCode) {
+        this(null, null, null, null, errorCode);
+    }
 
-    public IdpResponse(String providerId, @Nullable String email) {
+    public IdpResponse(String providerId, String email) {
         this(providerId, email, null, null);
     }
 
-    public IdpResponse(
-            String providerId, @Nullable String email, @Nullable String token) {
+    public IdpResponse(String providerId, @Nullable String email, @Nullable String token) {
         this(providerId, email, token, null);
     }
 
@@ -45,10 +50,20 @@ public IdpResponse(
             @Nullable String email,
             @Nullable String token,
             @Nullable String secret) {
+        this(providerId, email, token, secret, ResultCodes.OK);
+    }
+
+    public IdpResponse(
+            String providerId,
+            @Nullable String email,
+            @Nullable String token,
+            @Nullable String secret,
+            int errorCode) {
         mProviderId = providerId;
         mEmail = email;
         mToken = token;
         mSecret = secret;
+        mErrorCode = errorCode;
     }
 
     public static final Creator<IdpResponse> CREATOR = new Creator<IdpResponse>() {
@@ -58,7 +73,8 @@ public IdpResponse createFromParcel(Parcel in) {
                     in.readString(),
                     in.readString(),
                     in.readString(),
-                    in.readString()
+                    in.readString(),
+                    in.readInt()
             );
         }
 
@@ -71,6 +87,7 @@ public IdpResponse[] newArray(int size) {
     /**
      * Get the type of provider. e.g. {@link AuthUI#GOOGLE_PROVIDER}
      */
+    @Nullable
     public String getProviderType() {
         return mProviderId;
     }
@@ -99,6 +116,13 @@ public String getEmail() {
         return mEmail;
     }
 
+    /**
+     * Get the error code for a failed sign in
+     */
+    public int getErrorCode() {
+        return mErrorCode;
+    }
+
     @Override
     public int describeContents() {
         return 0;
@@ -110,6 +134,7 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeString(mEmail);
         dest.writeString(mToken);
         dest.writeString(mSecret);
+        dest.writeInt(mErrorCode);
     }
 
     /**
@@ -120,6 +145,18 @@ public void writeToParcel(Parcel dest, int flags) {
      */
     @Nullable
     public static IdpResponse fromResultIntent(Intent resultIntent) {
-        return resultIntent.getParcelableExtra(ExtraConstants.EXTRA_IDP_RESPONSE);
+        if (resultIntent != null) {
+            return resultIntent.getParcelableExtra(ExtraConstants.EXTRA_IDP_RESPONSE);
+        } else {
+            return null;
+        }
+    }
+
+    public static Intent getIntent(IdpResponse response) {
+        return new Intent().putExtra(ExtraConstants.EXTRA_IDP_RESPONSE, response);
+    }
+
+    public static Intent getErrorCodeIntent(int errorCode) {
+        return new Intent().putExtra(ExtraConstants.EXTRA_IDP_RESPONSE, new IdpResponse(errorCode));
     }
 }

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

@@ -0,0 +1,23 @@
+package com.firebase.ui.auth;
+
+import android.app.Activity;
+
+/**
+ * Result codes returned when using {@link AuthUI.SignInIntentBuilder#build()} with
+ * {@code startActivityForResult}.
+ */
+public final class ResultCodes {
+    private ResultCodes() {
+        // We don't want people to initialize this class
+    }
+
+    /**
+     * Sign in succeeded
+     **/
+    public static final int OK = Activity.RESULT_OK;
+
+    /**
+     * Sign in canceled by user
+     **/
+    public static final int CANCELED = Activity.RESULT_CANCELED;
+}

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

@@ -18,6 +18,7 @@
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 
+import com.firebase.ui.auth.IdpResponse;
 import com.firebase.ui.auth.util.signincontainer.SaveSmartLock;
 import com.google.firebase.auth.FirebaseUser;
 
@@ -48,7 +49,8 @@ public SaveSmartLock getSaveSmartLockInstance() {
     public void saveCredentialsOrFinish(
             @Nullable SaveSmartLock saveSmartLock,
             FirebaseUser firebaseUser,
-            @NonNull String password) {
-        saveCredentialsOrFinish(saveSmartLock, mActivity, firebaseUser, password, null);
+            @NonNull String password,
+            IdpResponse response) {
+        saveCredentialsOrFinish(saveSmartLock, mActivity, firebaseUser, password, response);
     }
 }

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

@@ -10,14 +10,14 @@
 import android.support.v4.app.FragmentActivity;
 
 import com.firebase.ui.auth.IdpResponse;
+import com.firebase.ui.auth.ResultCodes;
 import com.firebase.ui.auth.util.signincontainer.SaveSmartLock;
 import com.google.android.gms.auth.api.Auth;
 import com.google.android.gms.auth.api.credentials.CredentialsApi;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.auth.FirebaseAuth;
 import com.google.firebase.auth.FirebaseUser;
 
-import static android.app.Activity.RESULT_OK;
 import static com.firebase.ui.auth.util.Preconditions.checkNotNull;
 
 public class BaseHelper {
@@ -111,9 +111,9 @@ public void saveCredentialsOrFinish(
             Activity activity,
             FirebaseUser firebaseUser,
             @Nullable String password,
-            @Nullable IdpResponse response) {
+            IdpResponse response) {
         if (saveSmartLock == null) {
-            finishActivity(activity, RESULT_OK, new Intent());
+            finishActivity(activity, ResultCodes.OK, new Intent());
         } else {
             saveSmartLock.saveCredentialsOrFinish(
                     firebaseUser,