fix(Auth) Mapping correct error when Device Operations fail due to user not signed in.

Author: sebaland

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Dependency/AuthDeviceServiceAdapter.swift

@@ -6,6 +6,11 @@
 //
 
 import Amplify
+#if COCOAPODS
+import AWSMobileClient
+#else
+import AWSMobileClientXCF
+#endif
 
 struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
 
@@ -19,8 +24,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
                       completionHandler: @escaping (Result<[AuthDevice], AuthError>) -> Void) {
 
         awsMobileClient.listDevices { result, error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
@@ -42,8 +46,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
 
         guard let device = request.device else {
             awsMobileClient.forgetCurrentDevice { error in
-                if let error = error {
-                    let authError = AuthErrorHelper.toAuthError(error)
+                if let authError = mapToAuthError(error) {
                     completionHandler(.failure(authError))
                     return
                 }
@@ -52,8 +55,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
             return
         }
         awsMobileClient.forgetDevice(deviceId: device.id) { error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
@@ -66,12 +68,29 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
     func rememberDevice(request: AuthRememberDeviceRequest,
                         completionHandler: @escaping (Result<Void, AuthError>) -> Void) {
         awsMobileClient.updateDeviceStatus(remembered: true) { _, error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
             completionHandler(.success(()))
         }
     }
+
+    private func mapToAuthError(_ error: Error?) -> AuthError? {
+        guard let error = error else {
+            return nil
+        }
+
+        // `.notSignedIn` should be handled explicitly and not as part of AuthErrorHelper
+        if let awsMobileClientError = error as? AWSMobileClientError,
+            case .notSignedIn = awsMobileClientError {
+            return AuthError.signedOut(
+                AuthPluginErrorConstants.userSignedOutError.errorDescription,
+                AuthPluginErrorConstants.userSignedOutError.recoverySuggestion,
+                error
+            )
+        } else {
+            return AuthErrorHelper.toAuthError(error)
+        }
+    }
 }

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Constants/AuthPluginErrorConstants.swift

@@ -143,6 +143,10 @@ struct AuthPluginErrorConstants {
     static let changePasswordUnableToSignInError: AuthPluginErrorString = (
     "Could not change password, the user session is expired",
     "Re-authenticate the user by using one of the signIn apis")
+
+    static let userSignedOutError: AuthPluginErrorString = (
+    "There is no user signed in to the Auth category",
+    "SignIn to Auth category by using one of the sign in methods and then try again")
 }
 
 // Field validation errors