chore(auth): add custom network preferences for AWSCognitoAuthPlugin (#2208)

Author: mateusforgi

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin+Configure.swift

@@ -98,7 +98,18 @@ extension AWSCognitoAuthPlugin {
         }
         let region = (regionString as NSString).aws_regionTypeValue()
         let anonymousCredentialProvider = AWSAnonymousCredentialsProvider()
-        return AmplifyAWSServiceConfiguration(region: region, credentialsProvider: anonymousCredentialProvider)
+        let service = AmplifyAWSServiceConfiguration(region: region, credentialsProvider: anonymousCredentialProvider)
+        setUserPreferencesForService(service: service)
+        return service
+    }
+    
+    func setUserPreferencesForService(service: AmplifyAWSServiceConfiguration) {
+        guard let networkPreferences = networkPreferences else {
+            return
+        }
+        service.maxRetryCount = networkPreferences.maxRetryCount
+        service.timeoutIntervalForRequest = networkPreferences.timeoutIntervalForRequest
+        service.timeoutIntervalForResource = networkPreferences.timeoutIntervalForResource
     }
 
     func userPoolServiceConfiguration(from authConfiguration: JSONValue) throws -> AmplifyAWSServiceConfiguration? {
@@ -109,11 +120,14 @@ extension AWSCognitoAuthPlugin {
         }
         let region = (regionString as NSString).aws_regionTypeValue()
 
+        let service: AmplifyAWSServiceConfiguration
         if  let endpoint = try resolveCognitoOverrideEndpoint(using: authConfiguration, region: region) {
-            return AmplifyAWSServiceConfiguration(region: region, endpoint: endpoint)
+            service = AmplifyAWSServiceConfiguration(region: region, endpoint: endpoint)
         } else {
-            return AmplifyAWSServiceConfiguration(region: region)
+            service = AmplifyAWSServiceConfiguration(region: region)
         }
+        setUserPreferencesForService(service: service)
+        return service
     }
 
     func resolveCognitoOverrideEndpoint(

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin.swift

@@ -44,6 +44,9 @@ final public class AWSCognitoAuthPlugin: AuthCategoryPlugin {
     public var key: PluginKey {
         return "awsCognitoAuthPlugin"
     }
+    
+    /// The user network preferences for timeout and retry
+    let networkPreferences: AWSCognitoNetworkPreferences?
 
     public func getEscapeHatch() -> AWSCognitoAuthService {
         if let internalAuthorizationProvider = authorizationProvider as? AuthorizationProviderAdapter,
@@ -55,6 +58,14 @@ final public class AWSCognitoAuthPlugin: AuthCategoryPlugin {
 
     /// Instantiates an instance of the AWSCognitoAuthPlugin.
     public init() {
+        self.networkPreferences = nil
+    }
+    
+    /// Instantiates an instance of the AWSCognitoAuthPlugin with custom network preferences
+    /// - Parameters:
+    ///   - networkPreferences: network preferences
+    public init(networkPreferences: AWSCognitoNetworkPreferences) {
+        self.networkPreferences = networkPreferences
     }
 }
 

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Models/AWSCognitoNetworkPreferences.swift

@@ -0,0 +1,28 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+public struct AWSCognitoNetworkPreferences {
+    
+    /// The maximum number of retries for failed requests. The value needs to be between 0 and 10 inclusive. If set to higher than 10, it becomes 10.
+    public let maxRetryCount: UInt32
+    
+    /// The timeout interval to use when waiting for additional data.
+    public let timeoutIntervalForRequest: Double
+    
+    /// The maximum amount of time that a resource request should be allowed to take.
+    public let timeoutIntervalForResource: Double
+    
+    public init(maxRetryCount: UInt32,
+                timeoutIntervalForRequest: Double,
+                timeoutIntervalForResource: Double) {
+        self.maxRetryCount = maxRetryCount
+        self.timeoutIntervalForRequest = timeoutIntervalForRequest
+        self.timeoutIntervalForResource = timeoutIntervalForResource
+    }
+}

AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/ConfigurationTests/AWSCognitoAuthPluginConfigTests.swift

@@ -7,7 +7,7 @@
 
 import XCTest
 @testable import Amplify
-import AWSCognitoAuthPlugin
+@testable import AWSCognitoAuthPlugin
 
 class AWSCognitoAuthPluginConfigTests: XCTestCase {
 
@@ -318,4 +318,42 @@ class AWSCognitoAuthPluginConfigTests: XCTestCase {
         expectationList.append(signUpExpectation2)
         wait(for: expectationList, timeout: 10, enforceOrder: true)
     }
+    
+    func testUserNetworkPreferencesForIdentityPoolService() throws {
+        let networkPreferences = AWSCognitoNetworkPreferences(maxRetryCount: 0,
+                                                              timeoutIntervalForRequest: 30,
+                                                              timeoutIntervalForResource: 30)
+        let plugin = AWSCognitoAuthPlugin(networkPreferences: networkPreferences)
+
+        let json = JSONValue(dictionaryLiteral: ("CredentialsProvider",
+                                                  .init(dictionaryLiteral: ("CognitoIdentity",
+                                                                            .init(dictionaryLiteral: ("Default",
+                                                                                                      .init(dictionaryLiteral: ("Region", "us-east-1"))))))))
+        let identityPoolConfig = plugin.identityPoolServiceConfiguration(from: json)
+
+        XCTAssertEqual(identityPoolConfig?.maxRetryCount, networkPreferences.maxRetryCount)
+        XCTAssertEqual(identityPoolConfig?.timeoutIntervalForResource, networkPreferences.timeoutIntervalForResource)
+        XCTAssertEqual(identityPoolConfig?.timeoutIntervalForRequest, networkPreferences.timeoutIntervalForRequest)
+    }
+    
+    func testUserNetworkPreferencesForUserPoolService() throws {
+        let networkPreferences = AWSCognitoNetworkPreferences(maxRetryCount: 0,
+                                                              timeoutIntervalForRequest: 30,
+                                                              timeoutIntervalForResource: 30)
+        let plugin = AWSCognitoAuthPlugin(networkPreferences: networkPreferences)
+        
+        let json = JSONValue(dictionaryLiteral: ("CognitoUserPool",
+                                                 .init(dictionaryLiteral: ("Default",
+                                                                           .init(dictionaryLiteral: ("Region", "us-east-1"))))))
+        let identityPoolConfig = try plugin.userPoolServiceConfiguration(from: json)
+
+        XCTAssertEqual(identityPoolConfig?.maxRetryCount, networkPreferences.maxRetryCount)
+        XCTAssertEqual(identityPoolConfig?.timeoutIntervalForResource, networkPreferences.timeoutIntervalForResource)
+        XCTAssertEqual(identityPoolConfig?.timeoutIntervalForRequest, networkPreferences.timeoutIntervalForRequest)
+    }
+    
+    func testNoUserPreferences() throws {
+        let plugin = AWSCognitoAuthPlugin()
+        XCTAssertNil(plugin.networkPreferences)
+    }
 }