feat(Auth): Remove options from API's (#3075)

harsh62 · harsh62 · commit d8cea93b7c1d · 2023-08-28T15:30:12.000-04:00
* feat(Auth): Remove options from API's that are not needed

* removing options from setupTOTP API
diff --git a/Amplify/Categories/Auth/AuthCategory+ClientBehavior.swift b/Amplify/Categories/Auth/AuthCategory+ClientBehavior.swift
@@ -75,10 +75,8 @@ extension AuthCategory: AuthCategoryBehavior {
         try await plugin.confirmResetPassword(for: username, with: newPassword, confirmationCode: confirmationCode, options: options)
     }
 
-    public func setUpTOTP(
-        options: SetUpTOTPRequest.Options? = nil
-    ) async throws -> TOTPSetupDetails {
-        try await plugin.setUpTOTP(options: options)
+    public func setUpTOTP() async throws -> TOTPSetupDetails {
+        try await plugin.setUpTOTP()
     }
 
     public func verifyTOTPSetup(
diff --git a/Amplify/Categories/Auth/AuthCategoryBehavior.swift b/Amplify/Categories/Auth/AuthCategoryBehavior.swift
@@ -130,11 +130,7 @@ public protocol AuthCategoryBehavior: AuthCategoryUserBehavior, AuthCategoryDevi
     /// Calling this method will initiate TOTP setup process and returns a shared secret that can be used to generate QR code. 
     /// The setup details also contains a URI generator helper that can be used to retireve a TOTP Setup URI.
     ///
-    /// - Parameters:
-    ///   - options: Parameters specific to plugin behavior
-    func setUpTOTP(
-        options: SetUpTOTPRequest.Options?
-    ) async throws -> TOTPSetupDetails
+    func setUpTOTP() async throws -> TOTPSetupDetails
 
     /// Verifies TOTP Setup
     ///
diff --git a/Amplify/Categories/Auth/Request/SetUpTOTPRequest.swift b/Amplify/Categories/Auth/Request/SetUpTOTPRequest.swift
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin+PluginSpecificAPI.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin+PluginSpecificAPI.swift
@@ -33,30 +33,20 @@ public extension AWSCognitoAuthPlugin {
         try await task.value
     }
 
-    func fetchMFAPreference(
-        options: FetchMFAPreferenceRequest.Options? = nil
-    ) async throws -> UserMFAPreference {
-        let options = options ?? FetchMFAPreferenceRequest.Options()
-        let request = FetchMFAPreferenceRequest(options: options)
+    func fetchMFAPreference() async throws -> UserMFAPreference {
         let task = FetchMFAPreferenceTask(
-            request,
             authStateMachine: authStateMachine,
             userPoolFactory: authEnvironment.cognitoUserPoolFactory)
         return try await task.value
     }
 
     func updateMFAPreference(
         sms: MFAPreference?,
-        totp: MFAPreference?,
-        options: UpdateMFAPreferenceRequest.Options? = nil
+        totp: MFAPreference?
     ) async throws {
-        let options = options ?? UpdateMFAPreferenceRequest.Options()
-        let request = UpdateMFAPreferenceRequest(
-            options: options,
-            smsPreference: sms,
-            totpPreference: totp)
         let task = UpdateMFAPreferenceTask(
-            request,
+            smsPreference: sms,
+            totpPreference: totp,
             authStateMachine: authStateMachine,
             userPoolFactory: authEnvironment.cognitoUserPoolFactory)
         return try await task.value
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/AWSCognitoAuthPluginBehavior.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/AWSCognitoAuthPluginBehavior.swift
@@ -40,21 +40,15 @@ protocol AWSCognitoAuthPluginBehavior: AuthCategoryPlugin {
 
     /// Fetches users MFA preferences
     ///
-    /// - Parameters:
-    ///   - options: Parameters specific to plugin behavior.
-    func fetchMFAPreference(
-        options: FetchMFAPreferenceRequest.Options?
-    ) async throws -> UserMFAPreference
+    func fetchMFAPreference() async throws -> UserMFAPreference
 
     /// Updates users MFA preferences
     ///
     /// - Parameters:
     ///   - sms: The preference that needs to be updated for SMS
     ///   - totp: The preference that needs to be updated for TOTP
-    ///   - options: Parameters specific to plugin behavior.
     func updateMFAPreference(
         sms: MFAPreference?,
-        totp: MFAPreference?,
-        options: UpdateMFAPreferenceRequest.Options?
+        totp: MFAPreference?
     ) async throws
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/ClientBehavior/AWSCognitoAuthPlugin+ClientBehavior.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/ClientBehavior/AWSCognitoAuthPlugin+ClientBehavior.swift
@@ -167,13 +167,8 @@ extension AWSCognitoAuthPlugin: AuthCategoryBehavior {
         }
     }
 
-    public func setUpTOTP(
-        options: SetUpTOTPRequest.Options?
-    ) async throws -> TOTPSetupDetails {
-        let options = options ?? SetUpTOTPRequest.Options()
-        let request = SetUpTOTPRequest(options: options)
+    public func setUpTOTP() async throws -> TOTPSetupDetails {
         let task = SetUpTOTPTask(
-            request,
             authStateMachine: authStateMachine,
             userPoolFactory: authEnvironment.cognitoUserPoolFactory)
         return try await taskQueue.sync {
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Request/FetchMFAPreferenceRequest.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Request/FetchMFAPreferenceRequest.swift
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Request/UpdateMFAPreferenceRequest.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Request/UpdateMFAPreferenceRequest.swift
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/FetchMFAPreferenceTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/FetchMFAPreferenceTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-protocol AuthFetchMFAPreferenceTask: AmplifyAuthTask where Request == FetchMFAPreferenceRequest,
+protocol AuthFetchMFAPreferenceTask: AmplifyAuthTask where Request == Void,
                                                            Success == UserMFAPreference,
                                                            Failure == AuthError {}
 
@@ -24,7 +24,6 @@ class FetchMFAPreferenceTask: AuthFetchMFAPreferenceTask, DefaultLogger {
 
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
-    private let request: FetchMFAPreferenceRequest
     private let authStateMachine: AuthStateMachine
     private let userPoolFactory: CognitoUserPoolFactory
     private let taskHelper: AWSAuthTaskHelper
@@ -33,10 +32,8 @@ class FetchMFAPreferenceTask: AuthFetchMFAPreferenceTask, DefaultLogger {
         HubPayload.EventName.Auth.fetchMFAPreferenceAPI
     }
 
-    init(_ request: FetchMFAPreferenceRequest,
-         authStateMachine: AuthStateMachine,
+    init(authStateMachine: AuthStateMachine,
          userPoolFactory: @escaping CognitoUserPoolFactory) {
-        self.request = request
         self.authStateMachine = authStateMachine
         self.userPoolFactory = userPoolFactory
         self.taskHelper = AWSAuthTaskHelper(authStateMachine: authStateMachine)
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AuthSetUpTOTPTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AuthSetUpTOTPTask.swift
@@ -8,7 +8,7 @@
 import Foundation
 import Amplify
 
-protocol AuthSetUpTOTPTask: AmplifyAuthTask where Request == SetUpTOTPRequest, Success == TOTPSetupDetails, Failure == AuthError {}
+protocol AuthSetUpTOTPTask: AmplifyAuthTask where Request == Void, Success == TOTPSetupDetails, Failure == AuthError {}
 
 public extension HubPayload.EventName.Auth {
 
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/SetUpTOTPTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/SetUpTOTPTask.swift
@@ -15,7 +15,6 @@ class SetUpTOTPTask: AuthSetUpTOTPTask, DefaultLogger {
 
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
-    private let request: SetUpTOTPRequest
     private let authStateMachine: AuthStateMachine
     private let userPoolFactory: CognitoUserPoolFactory
     private let taskHelper: AWSAuthTaskHelper
@@ -24,10 +23,8 @@ class SetUpTOTPTask: AuthSetUpTOTPTask, DefaultLogger {
         HubPayload.EventName.Auth.setUpTOTPAPI
     }
 
-    init(_ request: SetUpTOTPRequest,
-         authStateMachine: AuthStateMachine,
+    init(authStateMachine: AuthStateMachine,
          userPoolFactory: @escaping CognitoUserPoolFactory) {
-        self.request = request
         self.authStateMachine = authStateMachine
         self.userPoolFactory = userPoolFactory
         self.taskHelper = AWSAuthTaskHelper(authStateMachine: authStateMachine)
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UpdateMFAPreferenceTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UpdateMFAPreferenceTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-protocol AuthUpdateMFAPreferenceTask: AmplifyAuthTask where Request == UpdateMFAPreferenceRequest,
+protocol AuthUpdateMFAPreferenceTask: AmplifyAuthTask where Request == Void,
                                                             Success == Void,
                                                             Failure == AuthError {}
 
@@ -24,7 +24,8 @@ class UpdateMFAPreferenceTask: AuthUpdateMFAPreferenceTask, DefaultLogger {
 
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
-    private let request: UpdateMFAPreferenceRequest
+    private let smsPreference: MFAPreference?
+    private let totpPreference: MFAPreference?
     private let authStateMachine: AuthStateMachine
     private let userPoolFactory: CognitoUserPoolFactory
     private let taskHelper: AWSAuthTaskHelper
@@ -33,10 +34,12 @@ class UpdateMFAPreferenceTask: AuthUpdateMFAPreferenceTask, DefaultLogger {
         HubPayload.EventName.Auth.updateMFAPreferenceAPI
     }
 
-    init(_ request: UpdateMFAPreferenceRequest,
+    init(smsPreference: MFAPreference?,
+         totpPreference: MFAPreference?,
          authStateMachine: AuthStateMachine,
          userPoolFactory: @escaping CognitoUserPoolFactory) {
-        self.request = request
+        self.smsPreference = smsPreference
+        self.totpPreference = totpPreference
         self.authStateMachine = authStateMachine
         self.userPoolFactory = userPoolFactory
         self.taskHelper = AWSAuthTaskHelper(authStateMachine: authStateMachine)
@@ -60,8 +63,8 @@ class UpdateMFAPreferenceTask: AuthUpdateMFAPreferenceTask, DefaultLogger {
         let userPoolService = try userPoolFactory()
         let input = SetUserMFAPreferenceInput(
             accessToken: accessToken,
-            smsMfaSettings: request.smsPreference?.smsSetting,
-            softwareTokenMfaSettings: request.totpPreference?.softwareTokenSetting)
+            smsMfaSettings: smsPreference?.smsSetting,
+            softwareTokenMfaSettings: totpPreference?.softwareTokenSetting)
         _ = try await userPoolService.setUserMFAPreference(input: input)
     }
 }
diff --git a/AmplifyPlugins/Auth/Tests/AWSCognitoAuthPluginUnitTests/TaskTests/ClientBehaviorTests/MFA/SetUpTOTPTaskTests.swift b/AmplifyPlugins/Auth/Tests/AWSCognitoAuthPluginUnitTests/TaskTests/ClientBehaviorTests/MFA/SetUpTOTPTaskTests.swift
@@ -32,7 +32,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let setUpTOTPResult = try await plugin.setUpTOTP(options: nil)
+            let setUpTOTPResult = try await plugin.setUpTOTP()
             XCTAssertEqual(setUpTOTPResult.sharedSecret, "sharedSecret")
         } catch {
             XCTFail("Received failure with error \(error)")
@@ -59,7 +59,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
 
         } catch {
@@ -90,7 +90,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
 
         } catch {
@@ -121,7 +121,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
 
         } catch {
@@ -152,7 +152,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
         } catch {
             guard case AuthError.service(_, _, let underlyingError) = error else {
@@ -185,7 +185,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
         } catch {
             guard case AuthError.notAuthorized(_, _, _) = error else {
@@ -214,7 +214,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
         } catch {
             guard case AuthError.service(_, _, let underlyingError) = error else {
@@ -245,7 +245,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
         } catch {
             guard case AuthError.service(_, _, let underlyingError) = error else {
@@ -277,7 +277,7 @@ class SetUpTOTPTaskTests: BasePluginTest {
             })
 
         do {
-            let _ = try await plugin.setUpTOTP(options: nil)
+            let _ = try await plugin.setUpTOTP()
             XCTFail("Should return an error if the result from service is invalid")
         } catch {
             guard case AuthError.unknown = error else {
diff --git a/AmplifyTestCommon/Mocks/MockAuthCategoryPlugin.swift b/AmplifyTestCommon/Mocks/MockAuthCategoryPlugin.swift
@@ -99,9 +99,7 @@ class MockAuthCategoryPlugin: MessageReporter, AuthCategoryPlugin {
 
     }
 
-    public func setUpTOTP(
-        options: SetUpTOTPRequest.Options?
-    ) async throws -> TOTPSetupDetails {
+    public func setUpTOTP() async throws -> TOTPSetupDetails {
         fatalError()
     }
 

Original file line number	Diff line number	Diff line change
`@@ -75,10 +75,8 @@ extension AuthCategory: AuthCategoryBehavior {`
`75`	`75`	`try await plugin.confirmResetPassword(for: username, with: newPassword, confirmationCode: confirmationCode, options: options)`
`76`	`76`	`}`
`77`	`77`
`78`		`- public func setUpTOTP(`
`79`		`- options: SetUpTOTPRequest.Options? = nil`
`80`		`- ) async throws -> TOTPSetupDetails {`
`81`		`- try await plugin.setUpTOTP(options: options)`
	`78`	`+ public func setUpTOTP() async throws -> TOTPSetupDetails {`
	`79`	`+ try await plugin.setUpTOTP()`
`82`	`80`	`}`
`83`	`81`
`84`	`82`	`public func verifyTOTPSetup(`
Original file line number	Diff line number	Diff line change
`@@ -167,13 +167,8 @@ extension AWSCognitoAuthPlugin: AuthCategoryBehavior {`
`167`	`167`	`}`
`168`	`168`	`}`
`169`	`169`
`170`		`- public func setUpTOTP(`
`171`		`- options: SetUpTOTPRequest.Options?`
`172`		`- ) async throws -> TOTPSetupDetails {`
`173`		`- let options = options ?? SetUpTOTPRequest.Options()`
`174`		`- let request = SetUpTOTPRequest(options: options)`
	`170`	`+ public func setUpTOTP() async throws -> TOTPSetupDetails {`
`175`	`171`	`let task = SetUpTOTPTask(`
`176`		`- request,`
`177`	`172`	`authStateMachine: authStateMachine,`
`178`	`173`	`userPoolFactory: authEnvironment.cognitoUserPoolFactory)`
`179`	`174`	`return try await taskQueue.sync {`