feat(auth): add support for error codes and refactor AuthError
#518
Conversation
This file contains 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
dshukertjr
approved these changes
Sep 2, 2024
| @@ -40,7 +40,7 @@ private actor LiveSessionManager { | |||
| func session() async throws -> Session { | |||
| try await trace(using: logger) { | |||
| guard let currentSession = try sessionStorage.get() else { | |||
| throw AuthError.sessionNotFound | |||
| throw AuthError.sessionMissing | |||
There was a problem hiding this comment.
I feel like this could technically be considered a breaking change, but I will leave it up to you what to do with it.
There was a problem hiding this comment.
Not really since I added a static let sessionNotFound: AuthError { .sessionMissing }, and deprecated it.
In a Swift enum, cases and static let are "kinda" equivalent.
If client is expecting a sessionNotFound, he'll start getting a deprecation warning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What kind of change does this PR introduce?
This PR includes some changes on Auth error system, I tried my best to keep it compatible and without breaking changes.
If you see anything that could be a breaking change, please let me know.
What is the new behavior?
Error codes
Introduce
ErrorCodetype as a raw representable string, added static properties for each of the known error codes. Since error codes are raw representable strings, if an unknown error code is returned, decoding is going to work fine.Deprecated errors
missingExpClaimerror deprecated, it is never thrown now, but I kept it for retro-compatibilitymalformedJWTerror deprecated, it is never thrown now, but I kept it for retro-compatibilitysessionNotFounderror deprecated, usesessionMissinginsteadpkce(_:)error deprecated, usepkceGrantCodeExchangeinsteadinvalidImplicitGrantFlowURLerror deprecated, useimplicitGrantRedirectinsteadmissingURLerror deprecated, it is never thrown, but I kept it for retro-compatibilityapi(_:)error deprecated, useapi(message:errorCode:underlyingData:underlyingResponse:)insteadAdded errors
sessionMissingthrown when a session is required to proceed, but none was found, either thrown by the client, or returned by the server.weakPasswordthrown when password is deemed weak, check associated reasons to know why.api(message:errorCode:underlyingData:underlyingResponse:)thrown by API when an error occurs, checkerrorCodeto know more, or useunderlyingDataorunderlyingResponsefor access to the response which originated this error.pkceGrantCodeExchangethrown when an error happens during PKCE grant flow.implicitGrantRedirectthrown when an error happens during implicit grant flow.