Use strictly-typed result and error types [SDK-2977] #558
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
Currently, the
Result
type (aliased toAuth0Result
) has the error typed asError
instead of the specific error type (e.g.WebAuthError
,CredentialsManagerError
, etc), so the error has to be casted, and the compiler cannot enforce that Web Auth only producesWebAuthError
errors, and the Credentials Manager only producesCredentialsManagerError
, and so on. This unnecessarily complicates the error handling and degrades the DX.This PR replaces
Auth0Result
with more specific alternatives:AuthenticationResult<T>
->Result<T, AuthenticationError>
ManagementResult<T>
->Result<T, ManagementError>
WebAuthResult<T>
->Result<T, WebAuthError>
CredentialsManagerResult<T>
->Result<T, CredentialsManagerError>
Additionally, the Credentials Manager was updated to use a
Result
type, like the rest of the library.Testing
The Credentials Manager changes have been tested manually in test apps, by performing Web Auth login, saving the credentials, and then retrieving them, as follows:
Using Cocoapods
Using Carthage
macOS 11.6.1 CatalystCarthage does not support building XCFrameworks for macCatalystUsing SPM
Checklist