-
Notifications
You must be signed in to change notification settings - Fork 219
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
Migrate all errors to structs [SDK-2968] #552
Merged
Merged
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
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.
Changes
In Auth0.swift 1.x
WebAuthError
andCredentialsManagerError
are enums, and as such the consumers must switch exhaustively over all the cases. This means that adding new cases constitutes a breaking change. So this was the source of manyTODO:
comments, as new error cases needed to be added.This PR migrates all errors to be structs, and in the case of
WebAuthError
andCredentialsManagerError
in particular, all the former cases are now static properties, meaning that they can be switched over but that switch can never be exhaustive. So adding new error cases will not be a breaking change.Additionally, the error handling DX was improved, as now all errors conform to
Equatable
andCustomDebugStringConvertible
, and all errors are being properly wrapped. Before, Web Auth could produce either aWebAuthError
or anAuthenticationError
; now it will only produce aWebAuthError
. Same for the Credentials Manager, which will only produce aCredentialsManagerError
.Testing
Checklist