fix(auth): handle tooManyRequests and limitExceeded separately in AuthErrorHelper (#1122)

thisisabhash · web-flow · commit 8bf26108c6b1 · 2021-03-23T14:20:05.000-07:00
* fix(auth): handle tooManyRequests and limitExceeded separately in AuthErrorHelper

* fix(auth): modify unit tests for AuthErrorHelper

* fix(auth): resolve review comments

Co-authored-by: Abhash Kumar Singh &lt;abhashs@amazon.com&gt;
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Models/Error/AWSCognitoAuthError.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Models/Error/AWSCognitoAuthError.swift
@@ -34,7 +34,7 @@ public enum AWSCognitoAuthError: Error {
     /// Password given is invalid.
     case invalidPassword
 
-    /// Number of allowed operation have exceeded.
+    /// Limit exceeded for the requested AWS resource
     case limitExceeded
 
     /// Amazon Cognito cannot find a multi-factor authentication (MFA) method.
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Constants/AuthPluginErrorConstants.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Constants/AuthPluginErrorConstants.swift
@@ -229,7 +229,11 @@ extension AuthPluginErrorConstants {
     static let tooManyFailedError: RecoverySuggestion = "User might have tried too many times with failed input"
 
     static let tooManyRequestError: RecoverySuggestion = """
-    Make sure the requests send are controlled and the errors are properlly handled
+    Make sure the requests send are controlled and the errors are properly handled
+    """
+
+    static let limitExceededError: RecoverySuggestion = """
+    Make sure that the request made to the particular AWS resources are under the resource quota limits
     """
 
     static let configurationError: RecoverySuggestion = """
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Utils/AuthErrorHelper.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Utils/AuthErrorHelper.swift
@@ -99,12 +99,16 @@ struct AuthErrorHelper {
                                             AuthPluginErrorConstants.tooManyFailedError,
                                             AWSCognitoAuthError.failedAttemptsLimitExceeded)
 
-        case .tooManyRequests(let message),
-             .limitExceeded(let message):
+        case .tooManyRequests(let message):
             return AuthError.service(message,
                                             AuthPluginErrorConstants.tooManyRequestError,
                                             AWSCognitoAuthError.requestLimitExceeded)
 
+        case .limitExceeded(let message):
+            return AuthError.service(message,
+                                     AuthPluginErrorConstants.limitExceededError,
+                                     AWSCognitoAuthError.limitExceeded)
+
         case .errorLoadingPage(let message):
             return AuthError.service(message,
                                             AuthPluginErrorConstants.errorLoadingPageError,
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorChangePasswordTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorChangePasswordTests.swift
@@ -149,7 +149,7 @@ class UserBehaviorChangePasswordTests: BaseUserBehaviorTest {
     /// - When:
     ///    - I invoke changePassword with old password and new password
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testChangePasswordWithLimitExceededException() {
 
@@ -168,8 +168,8 @@ class UserBehaviorChangePasswordTests: BaseUserBehaviorTest {
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be requestLimitExceeded \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorConfirmAttributeTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorConfirmAttributeTests.swift
@@ -190,7 +190,7 @@ class UserBehaviorConfirmAttributeTests: BaseUserBehaviorTest {
     /// - When:
     ///    - I invoke confirmUpdateUserAttributes with confirmation code
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testConfirmUpdateUserAttributesWithLimitExceededException() {
 
@@ -210,8 +210,8 @@ class UserBehaviorConfirmAttributeTests: BaseUserBehaviorTest {
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be requestLimitExceeded \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorResendCodeTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthUserBehaviorTests/UserBehaviorResendCodeTests.swift
@@ -229,7 +229,7 @@ class UserBehaviorResendCodeTests: BaseUserBehaviorTest {
     /// - When:
     ///    - I invoke resendConfirmationCode
     /// - Then:
-    ///    - I should get a .service error with  .requestLimitExceeded as underlyingError
+    ///    - I should get a .service error with .limitExceeded as underlyingError
     ///
     func testResendConfirmationCodeWithLimitExceededException() {
 
@@ -249,8 +249,8 @@ class UserBehaviorResendCodeTests: BaseUserBehaviorTest {
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be requestLimitExceeded \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
 
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderConfirmResetPasswordTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderConfirmResetPasswordTests.swift
@@ -352,7 +352,7 @@ class AuthenticationProviderConfirmResetPasswordTests: BaseAuthenticationProvide
     /// - When:
     ///    - I invoke confirmResetPassword with a valid username, a new password and a confirmation code
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testConfirmResetPasswordWithLimitExceededException() {
 
@@ -374,8 +374,8 @@ class AuthenticationProviderConfirmResetPasswordTests: BaseAuthenticationProvide
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be resourceNotFound \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderConfirmSignupTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderConfirmSignupTests.swift
@@ -353,7 +353,7 @@ class AuthenticationProviderConfirmSignupTests: BaseAuthenticationProviderTest {
     /// - When:
     ///    - I invoke confirmSignup with a valid username and confirmationCode
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testConfirmSignUpWithLimitExceededException() {
 
@@ -374,8 +374,8 @@ class AuthenticationProviderConfirmSignupTests: BaseAuthenticationProviderTest {
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be resourceNotFound \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderResendSignupCodeTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderResendSignupCodeTests.swift
@@ -309,7 +309,7 @@ class AuthenticationProviderResendSignupCodeTests: BaseAuthenticationProviderTes
     /// - When:
     ///    - I invoke resendSignUpCode with a valid username
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testResendSignupCodeWithLimitExceededException() {
 
@@ -329,8 +329,8 @@ class AuthenticationProviderResendSignupCodeTests: BaseAuthenticationProviderTes
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be resourceNotFound \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderResetPasswordTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AuthenticationProviderTests/AuthenticationProviderResetPasswordTests.swift
@@ -303,7 +303,7 @@ class AuthenticationProviderResetPasswordTests: BaseAuthenticationProviderTest {
     /// - When:
     ///    - I invoke resetPassword with username
     /// - Then:
-    ///    - I should get a .requestLimitExceeded error
+    ///    - I should get a .limitExceeded error
     ///
     func testResetPasswordWithLimitExceededException() {
 
@@ -323,8 +323,8 @@ class AuthenticationProviderResetPasswordTests: BaseAuthenticationProviderTest {
                     XCTFail("Should produce service error instead of \(error)")
                     return
                 }
-                guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {
-                    XCTFail("Underlying error should be requestLimitExceeded \(error)")
+                guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {
+                    XCTFail("Underlying error should be limitExceeded \(error)")
                     return
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ class UserBehaviorChangePasswordTests: BaseUserBehaviorTest {`
`149`	`149`	`/// - When:`
`150`	`150`	`/// - I invoke changePassword with old password and new password`
`151`	`151`	`/// - Then:`
`152`		`- /// - I should get a .requestLimitExceeded error`
	`152`	`+ /// - I should get a .limitExceeded error`
`153`	`153`	`///`
`154`	`154`	`func testChangePasswordWithLimitExceededException() {`
`155`	`155`
`@@ -168,8 +168,8 @@ class UserBehaviorChangePasswordTests: BaseUserBehaviorTest {`
`168`	`168`	`XCTFail("Should produce service error instead of \(error)")`
`169`	`169`	`return`
`170`	`170`	`}`
`171`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`172`		`- XCTFail("Underlying error should be requestLimitExceeded \(error)")`
	`171`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`172`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`173`	`173`	`return`
`174`	`174`	`}`
`175`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ class UserBehaviorConfirmAttributeTests: BaseUserBehaviorTest {`
`190`	`190`	`/// - When:`
`191`	`191`	`/// - I invoke confirmUpdateUserAttributes with confirmation code`
`192`	`192`	`/// - Then:`
`193`		`- /// - I should get a .requestLimitExceeded error`
	`193`	`+ /// - I should get a .limitExceeded error`
`194`	`194`	`///`
`195`	`195`	`func testConfirmUpdateUserAttributesWithLimitExceededException() {`
`196`	`196`
`@@ -210,8 +210,8 @@ class UserBehaviorConfirmAttributeTests: BaseUserBehaviorTest {`
`210`	`210`	`XCTFail("Should produce service error instead of \(error)")`
`211`	`211`	`return`
`212`	`212`	`}`
`213`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`214`		`- XCTFail("Underlying error should be requestLimitExceeded \(error)")`
	`213`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`214`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`215`	`215`	`return`
`216`	`216`	`}`
`217`	`217`	`}`
Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,7 @@ class AuthenticationProviderConfirmResetPasswordTests: BaseAuthenticationProvide`
`352`	`352`	`/// - When:`
`353`	`353`	`/// - I invoke confirmResetPassword with a valid username, a new password and a confirmation code`
`354`	`354`	`/// - Then:`
`355`		`- /// - I should get a .requestLimitExceeded error`
	`355`	`+ /// - I should get a .limitExceeded error`
`356`	`356`	`///`
`357`	`357`	`func testConfirmResetPasswordWithLimitExceededException() {`
`358`	`358`
`@@ -374,8 +374,8 @@ class AuthenticationProviderConfirmResetPasswordTests: BaseAuthenticationProvide`
`374`	`374`	`XCTFail("Should produce service error instead of \(error)")`
`375`	`375`	`return`
`376`	`376`	`}`
`377`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`378`		`- XCTFail("Underlying error should be resourceNotFound \(error)")`
	`377`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`378`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`379`	`379`	`return`
`380`	`380`	`}`
`381`	`381`	`}`
Original file line number	Diff line number	Diff line change
`@@ -353,7 +353,7 @@ class AuthenticationProviderConfirmSignupTests: BaseAuthenticationProviderTest {`
`353`	`353`	`/// - When:`
`354`	`354`	`/// - I invoke confirmSignup with a valid username and confirmationCode`
`355`	`355`	`/// - Then:`
`356`		`- /// - I should get a .requestLimitExceeded error`
	`356`	`+ /// - I should get a .limitExceeded error`
`357`	`357`	`///`
`358`	`358`	`func testConfirmSignUpWithLimitExceededException() {`
`359`	`359`
`@@ -374,8 +374,8 @@ class AuthenticationProviderConfirmSignupTests: BaseAuthenticationProviderTest {`
`374`	`374`	`XCTFail("Should produce service error instead of \(error)")`
`375`	`375`	`return`
`376`	`376`	`}`
`377`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`378`		`- XCTFail("Underlying error should be resourceNotFound \(error)")`
	`377`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`378`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`379`	`379`	`return`
`380`	`380`	`}`
`381`	`381`	`}`
Original file line number	Diff line number	Diff line change
`@@ -309,7 +309,7 @@ class AuthenticationProviderResendSignupCodeTests: BaseAuthenticationProviderTes`
`309`	`309`	`/// - When:`
`310`	`310`	`/// - I invoke resendSignUpCode with a valid username`
`311`	`311`	`/// - Then:`
`312`		`- /// - I should get a .requestLimitExceeded error`
	`312`	`+ /// - I should get a .limitExceeded error`
`313`	`313`	`///`
`314`	`314`	`func testResendSignupCodeWithLimitExceededException() {`
`315`	`315`
`@@ -329,8 +329,8 @@ class AuthenticationProviderResendSignupCodeTests: BaseAuthenticationProviderTes`
`329`	`329`	`XCTFail("Should produce service error instead of \(error)")`
`330`	`330`	`return`
`331`	`331`	`}`
`332`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`333`		`- XCTFail("Underlying error should be resourceNotFound \(error)")`
	`332`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`333`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`334`	`334`	`return`
`335`	`335`	`}`
`336`	`336`	`}`
Original file line number	Diff line number	Diff line change
`@@ -303,7 +303,7 @@ class AuthenticationProviderResetPasswordTests: BaseAuthenticationProviderTest {`
`303`	`303`	`/// - When:`
`304`	`304`	`/// - I invoke resetPassword with username`
`305`	`305`	`/// - Then:`
`306`		`- /// - I should get a .requestLimitExceeded error`
	`306`	`+ /// - I should get a .limitExceeded error`
`307`	`307`	`///`
`308`	`308`	`func testResetPasswordWithLimitExceededException() {`
`309`	`309`
`@@ -323,8 +323,8 @@ class AuthenticationProviderResetPasswordTests: BaseAuthenticationProviderTest {`
`323`	`323`	`XCTFail("Should produce service error instead of \(error)")`
`324`	`324`	`return`
`325`	`325`	`}`
`326`		`- guard case .requestLimitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
`327`		`- XCTFail("Underlying error should be requestLimitExceeded \(error)")`
	`326`	`+ guard case .limitExceeded = (underlyingError as? AWSCognitoAuthError) else {`
	`327`	`+ XCTFail("Underlying error should be limitExceeded \(error)")`
`328`	`328`	`return`
`329`	`329`	`}`
`330`	`330`	`}`