user profile() error refactored

Author: NandanPrabhu

Auth0/CredentialsManager.swift

@@ -79,6 +79,7 @@ public struct CredentialsManager: Sendable {
     /// ```
     ///
     /// - Throws: A ``CredentialsManagerError`` if the credentials cannot be read from storage or the ID token cannot be decoded.
+    ///   The underlying `Error` can be accessed via the ``Auth0Error/cause-swift.property`` property.
     /// - Returns: The ``UserProfile`` extracted from the stored ID token, or `nil` if the ID token payload cannot be parsed.
     /// - Important: Access to this method will not be protected by biometric authentication.
     public func userProfile() throws -> UserProfile? {
@@ -89,7 +90,7 @@ public struct CredentialsManager: Sendable {
             let jwt = try decode(jwt: credentials.idToken)
             return UserProfile(json: jwt.body)
         } catch {
-            throw CredentialsManagerError(code: .noCredentials, cause: error)
+            throw CredentialsManagerError(code: .unknown, cause: error)
         }
     }
 

Auth0/CredentialsManagerError.swift

@@ -13,6 +13,7 @@ public struct CredentialsManagerError: Auth0Error, Sendable {
         case clearFailed
         case biometricsFailed
         case revokeFailed
+        case unknown
         case largeMinTTL(minTTL: Int, lifetime: Int)
     }
 
@@ -71,7 +72,11 @@ public struct CredentialsManagerError: Auth0Error, Sendable {
     /// The underlying ``AuthenticationError`` can be accessed via the ``Auth0Error/cause-9wuyi`` property.
     public static let revokeFailed: CredentialsManagerError = .init(code: .revokeFailed)
 
-    /// The `minTTL` requested is greater than the lifetime of the renewed access token. Request a lower `minTTL` or 
+    /// An unknown error occurred.
+    /// The underlying `Error` can be accessed via the ``Auth0Error/cause-9wuyi`` property.
+    public static let unknown: CredentialsManagerError = .init(code: .unknown)
+
+    /// The `minTTL` requested is greater than the lifetime of the renewed access token. Request a lower `minTTL` or
     /// increase the **Token Expiration** value in the settings page of your [Auth0 API](https://manage.auth0.com/#/apis/).
     /// This error does not include a ``Auth0Error/cause-9wuyi``.
     public static let largeMinTTL: CredentialsManagerError = .init(code: .largeMinTTL(minTTL: 0, lifetime: 0))
@@ -92,6 +97,7 @@ public extension CredentialsManagerError {
             return "Clearing of the credentials failed"
         case .biometricsFailed: return "The biometric authentication failed."
         case .revokeFailed: return "The revocation of the refresh token failed."
+        case .unknown: return "An unknown error occurred."
         case .largeMinTTL(let minTTL, let lifetime): return "The minTTL requested (\(minTTL)s) is greater than the"
             + " lifetime of the renewed access token (\(lifetime)s). Request a lower minTTL or increase the"
             + " 'Token Expiration' value in the settings page of your Auth0 API."

Auth0Tests/CredentialsManagerErrorSpec.swift

@@ -127,6 +127,12 @@ class CredentialsManagerErrorSpec: QuickSpec {
                 expect(error.localizedDescription) == message
             }
 
+            it("should return message for unknown error") {
+                let message = "An unknown error occurred."
+                let error = CredentialsManagerError(code: .unknown)
+                expect(error.localizedDescription) == message
+            }
+
             it("should return message when minTTL is too big") {
                 let minTTL = 7200
                 let lifetime = 3600

Auth0Tests/CredentialsManagerSpec.swift

@@ -374,7 +374,7 @@ class CredentialsManagerSpec: QuickSpec {
                 expect { try failingManager.store(apiCredentials: apiCreds, forAudience: Audience) }.to(throwError())
             }
 
-            it("should return nil for user when storage throws") {
+            it("should throw unknown error with cause when storage throws") {
                 class FailingReadStore: CredentialsStorage {
                     func getEntry(forKey key: String) throws -> Data {
                         throw SimpleKeychainError.itemNotFound
@@ -384,7 +384,14 @@ class CredentialsManagerSpec: QuickSpec {
                 }
 
                 let failingManager = CredentialsManager(authentication: authentication, storage: FailingReadStore())
-                expect(try? failingManager.userProfile()).to(beNil())
+                var thrownError: CredentialsManagerError?
+                expect {
+                    try failingManager.userProfile()
+                }.to(throwError { error in
+                    thrownError = error as? CredentialsManagerError
+                })
+                expect(thrownError?.code) == CredentialsManagerError.Code.unknown
+                expect(thrownError?.cause).notTo(beNil())
             }
 
             it("should return false for hasValid when storage throws") {
@@ -652,7 +659,14 @@ class CredentialsManagerSpec: QuickSpec {
             it("should not retrieve the user profile when the id token is not a jwt") {
                 let credentials = Credentials(accessToken: AccessToken, idToken: "not a jwt", expiresAt: Date(timeIntervalSinceNow: ExpiresIn))
                 expect { try credentialsManager.store(credentials: credentials) }.toNot(throwError())
-                expect { try credentialsManager.userProfile() }.to(throwError())
+                var thrownError: CredentialsManagerError?
+                expect {
+                    try credentialsManager.userProfile()
+                }.to(throwError { error in
+                    thrownError = error as? CredentialsManagerError
+                })
+                expect(thrownError?.code) == CredentialsManagerError.Code.unknown
+                expect(thrownError?.cause).notTo(beNil())
             }
 
         }