fix(Authenticator): Allowing to only override the desired errors when invoking the errorMap functions (#93)

sebaland · web-flow · commit 068bd3c5fc06 · 2024-09-13T15:45:25.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.7 (2024-09-13)
+
+### Bug Fixes
+- **Authenticator**: Allowing to only override the desired errors when invoking the errorMap functions (#93)
+
 ## 1.1.6 (2024-08-13)
 
 ### Bug Fixes
diff --git a/Sources/Authenticator/Authenticator.swift b/Sources/Authenticator/Authenticator.swift
@@ -290,7 +290,7 @@ public struct Authenticator<LoadingContent: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         for contentState in contentStates.allObjects {
             contentState.errorTransform = errorTransform
         }
diff --git a/Sources/Authenticator/Constants/ComponentInformation.swift b/Sources/Authenticator/Constants/ComponentInformation.swift
@@ -8,6 +8,6 @@
 import Foundation
 
 public class ComponentInformation {
-    public static let version = "1.1.6"
+    public static let version = "1.1.7"
     public static let name = "amplify-ui-swift-authenticator"
 }
diff --git a/Sources/Authenticator/States/AuthenticatorBaseState.swift b/Sources/Authenticator/States/AuthenticatorBaseState.swift
@@ -23,7 +23,7 @@ public class AuthenticatorBaseState: ObservableObject {
 
     @ObservedObject var credentials: Credentials
 
-    var errorTransform: ((AuthError) -> AuthenticatorError)? = nil
+    var errorTransform: ((AuthError) -> AuthenticatorError?)? = nil
     private(set) var authenticatorState: AuthenticatorStateProtocol = .empty
 
     init(credentials: Credentials) {
@@ -183,8 +183,8 @@ public class AuthenticatorBaseState: ObservableObject {
             return .unknown(from: error)
         }
 
-        if let errorTransform = errorTransform {
-            return errorTransform(authError)
+        if let customError = errorTransform?(authError) {
+            return customError
         }
 
         if let localizedMessage = localizedMessage(for: authError) {
diff --git a/Sources/Authenticator/Views/ConfirmResetPasswordView.swift b/Sources/Authenticator/Views/ConfirmResetPasswordView.swift
@@ -135,7 +135,7 @@ public struct ConfirmResetPasswordView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmSignInWithCustomChallengeView.swift b/Sources/Authenticator/Views/ConfirmSignInWithCustomChallengeView.swift
@@ -42,7 +42,7 @@ public struct ConfirmSignInWithCustomChallengeView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmSignInWithMFACodeView.swift b/Sources/Authenticator/Views/ConfirmSignInWithMFACodeView.swift
@@ -48,7 +48,7 @@ public struct ConfirmSignInWithMFACodeView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmSignInWithNewPasswordView.swift b/Sources/Authenticator/Views/ConfirmSignInWithNewPasswordView.swift
@@ -111,7 +111,7 @@ public struct ConfirmSignInWithNewPasswordView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmSignInWithTOTPCodeView.swift b/Sources/Authenticator/Views/ConfirmSignInWithTOTPCodeView.swift
@@ -43,7 +43,7 @@ public struct ConfirmSignInWithTOTPView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmSignUpView.swift b/Sources/Authenticator/Views/ConfirmSignUpView.swift
@@ -98,7 +98,7 @@ public struct ConfirmSignUpView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ConfirmVerifyUserView.swift b/Sources/Authenticator/Views/ConfirmVerifyUserView.swift
@@ -82,7 +82,7 @@ public struct ConfirmVerifyUserView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ContinueSignInWithMFASelectionView.swift b/Sources/Authenticator/Views/ContinueSignInWithMFASelectionView.swift
@@ -89,7 +89,7 @@ public struct ContinueSignInWithMFASelectionView<Header: View,
     
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/ContinueSignInWithTOTPSetupView.swift b/Sources/Authenticator/Views/ContinueSignInWithTOTPSetupView.swift
@@ -120,7 +120,7 @@ public struct ContinueSignInWithTOTPSetupView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/Internal/ConfirmSignInWithCodeView.swift b/Sources/Authenticator/Views/Internal/ConfirmSignInWithCodeView.swift
@@ -25,7 +25,7 @@ struct ConfirmSignInWithCodeView<Header: View,
         @ViewBuilder footerContent: () -> Footer = {
             EmptyView()
         },
-        errorTransform: ((AuthError) -> AuthenticatorError)? = nil,
+        errorTransform: ((AuthError) -> AuthenticatorError?)? = nil,
         mfaType: AuthenticatorMFAType
     ) {
         self.state = state
diff --git a/Sources/Authenticator/Views/ResetPasswordView.swift b/Sources/Authenticator/Views/ResetPasswordView.swift
@@ -113,7 +113,7 @@ public struct ResetPasswordView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/SignInView.swift b/Sources/Authenticator/Views/SignInView.swift
@@ -127,7 +127,7 @@ public struct SignInView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/SignUpView.swift b/Sources/Authenticator/Views/SignUpView.swift
@@ -91,7 +91,7 @@ public struct SignUpView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Sources/Authenticator/Views/VerifyUserView.swift b/Sources/Authenticator/Views/VerifyUserView.swift
@@ -78,7 +78,7 @@ public struct VerifyUserView<Header: View,
 
     /// Sets a custom error mapping function for the `AuthError`s that are displayed
     /// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
-    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {
+    public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {
         state.errorTransform = errorTransform
         return self
     }
diff --git a/Tests/AuthenticatorTests/States/AuthenticatorBaseStateTests.swift b/Tests/AuthenticatorTests/States/AuthenticatorBaseStateTests.swift
@@ -239,6 +239,22 @@ class AuthenticatorBaseStateTests: XCTestCase {
         XCTAssertEqual(authenticatorError.content, "A custom error")
     }
 
+    func testError_withCustomErrorTransformThatReturnsNil_shouldReturnDefaultError() {
+        var closureCount = 0
+        state.errorTransform = { error in
+            closureCount = 1
+            if case .service = error {
+                return .error(message: "A service error")
+            }
+            return nil
+        }
+        let authenticatorError = state.error(for: AuthError.notAuthorized("description", "recovery", nil))
+        XCTAssertEqual(closureCount, 1)
+        XCTAssertEqual(authenticatorError.style, .error)
+        let expectedMessage = "authenticator.authError.incorrectCredentials".localized()
+        XCTAssertEqual(authenticatorError.content, expectedMessage)
+    }
+
     func testError_withLocalizedCognitoError_shouldReturnLocalizedError() {
         let cognitoError = AWSCognitoAuthError.userNotFound
         let authenticatorError = state.error(for: AuthError.service("description", "recovery", cognitoError))

Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ public struct Authenticator<LoadingContent: View,`
`290`	`290`
`291`	`291`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`292`	`292`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`293`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`293`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`294`	`294`	`for contentState in contentStates.allObjects {`
`295`	`295`	`contentState.errorTransform = errorTransform`
`296`	`296`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@`
`8`	`8`	`import Foundation`
`9`	`9`
`10`	`10`	`public class ComponentInformation {`
`11`		`- public static let version = "1.1.6"`
	`11`	`+ public static let version = "1.1.7"`
`12`	`12`	`public static let name = "amplify-ui-swift-authenticator"`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public class AuthenticatorBaseState: ObservableObject {`
`23`	`23`
`24`	`24`	`@ObservedObject var credentials: Credentials`
`25`	`25`
`26`		`- var errorTransform: ((AuthError) -> AuthenticatorError)? = nil`
	`26`	`+ var errorTransform: ((AuthError) -> AuthenticatorError?)? = nil`
`27`	`27`	`private(set) var authenticatorState: AuthenticatorStateProtocol = .empty`
`28`	`28`
`29`	`29`	`init(credentials: Credentials) {`
`@@ -183,8 +183,8 @@ public class AuthenticatorBaseState: ObservableObject {`
`183`	`183`	`return .unknown(from: error)`
`184`	`184`	`}`
`185`	`185`
`186`		`- if let errorTransform = errorTransform {`
`187`		`- return errorTransform(authError)`
	`186`	`+ if let customError = errorTransform?(authError) {`
	`187`	`+ return customError`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`if let localizedMessage = localizedMessage(for: authError) {`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public struct ConfirmResetPasswordView<Header: View,`
`135`	`135`
`136`	`136`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`137`	`137`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`138`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`138`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`139`	`139`	`state.errorTransform = errorTransform`
`140`	`140`	`return self`
`141`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public struct ConfirmSignInWithCustomChallengeView<Header: View,`
`42`	`42`
`43`	`43`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`44`	`44`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`45`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`45`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`46`	`46`	`state.errorTransform = errorTransform`
`47`	`47`	`return self`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public struct ConfirmSignInWithMFACodeView<Header: View,`
`48`	`48`
`49`	`49`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`50`	`50`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`51`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`51`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`52`	`52`	`state.errorTransform = errorTransform`
`53`	`53`	`return self`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public struct ConfirmSignInWithNewPasswordView<Header: View,`
`111`	`111`
`112`	`112`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`113`	`113`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`114`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`114`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`115`	`115`	`state.errorTransform = errorTransform`
`116`	`116`	`return self`
`117`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public struct ConfirmSignInWithTOTPView<Header: View,`
`43`	`43`
`44`	`44`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`45`	`45`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`46`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`46`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`47`	`47`	`state.errorTransform = errorTransform`
`48`	`48`	`return self`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public struct ConfirmSignUpView<Header: View,`
`98`	`98`
`99`	`99`	/// Sets a custom error mapping function for the `AuthError`s that are displayed
`100`	`100`	/// - Parameter errorTransform: A closure that takes an `AuthError` and returns a ``AuthenticatorError`` that will be displayed.
`101`		`- public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError) -> Self {`
	`101`	`+ public func errorMap(_ errorTransform: @escaping (AuthError) -> AuthenticatorError?) -> Self {`
`102`	`102`	`state.errorTransform = errorTransform`
`103`	`103`	`return self`
`104`	`104`	`}`