-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Give clients much more detailed errors #1168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,47 @@ | ||
| package com.firebase.ui.auth; | ||
|
|
||
| import android.support.annotation.IntDef; | ||
|
|
||
| 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 Code {} | ||
|
|
||
| /** | ||
| * 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!"); | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
auth/src/main/java/com/firebase/ui/auth/FirebaseUiException.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package com.firebase.ui.auth; | ||
|
|
||
| import android.support.annotation.NonNull; | ||
| import android.support.annotation.RestrictTo; | ||
|
|
||
| /** | ||
| * Base class for all FirebaseUI exceptions. | ||
| */ | ||
| public class FirebaseUiException extends Exception { | ||
| private final int mErrorCode; | ||
|
|
||
| @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) | ||
| public FirebaseUiException(@ErrorCodes.Code int code) { | ||
| mErrorCode = code; | ||
| } | ||
|
|
||
| @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) | ||
| public FirebaseUiException(@ErrorCodes.Code int code, @NonNull String message) { | ||
| super(message); | ||
| mErrorCode = code; | ||
| } | ||
|
|
||
| @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) | ||
| public FirebaseUiException(@ErrorCodes.Code int code, | ||
| @NonNull String message, | ||
| @NonNull Throwable cause) { | ||
| super(message, cause); | ||
| mErrorCode = code; | ||
| } | ||
|
|
||
| @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) | ||
| public FirebaseUiException(@ErrorCodes.Code int code, @NonNull Throwable cause) { | ||
| super(cause); | ||
| mErrorCode = code; | ||
| } | ||
|
|
||
| /** | ||
| * @return error code associated with this exception | ||
| * @see com.firebase.ui.auth.ErrorCodes | ||
| */ | ||
| @ErrorCodes.Code | ||
| public final int getErrorCode() { | ||
| return mErrorCode; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 0 additions & 34 deletions
34
auth/src/main/java/com/firebase/ui/auth/data/model/FirebaseUiException.java
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible that anyone was relying on this interface? If so this is a breaking change .... if this is meant to be internal let's annotate it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, or at least, I know we've broken it before without notice. I'll annotate it.