add checks for a pending auth token refresh

Author: roninopf

swift-sdk/Internal/AuthManager.swift

@@ -43,12 +43,18 @@ class AuthManager: IterableInternalAuthManagerProtocol {
 
     // @objc attribute only needed for the pre-iOS 10 Timer constructor in queueAuthTokenExpirationRefresh
     @objc func requestNewAuthToken(hasFailedPriorAuth: Bool = false, onSuccess: ((String?) -> Void)? = nil) {
+        guard !pendingAuth else {
+            return
+        }
+        
         guard !self.hasFailedPriorAuth || !hasFailedPriorAuth else {
             return
         }
 
         self.hasFailedPriorAuth = hasFailedPriorAuth
 
+        pendingAuth = true
+        
         delegate?.onAuthTokenRequested { [weak self] retrievedAuthToken in
             self?.onAuthTokenReceived(retrievedAuthToken: retrievedAuthToken, onSuccess: onSuccess)
         }
@@ -68,6 +74,7 @@ class AuthManager: IterableInternalAuthManagerProtocol {
 
     private var authToken: String?
 
+    private var pendingAuth: Bool = false
     private var hasFailedPriorAuth: Bool = false
 
     private weak var delegate: IterableAuthDelegate?
@@ -86,6 +93,8 @@ class AuthManager: IterableInternalAuthManagerProtocol {
     }
 
     private func onAuthTokenReceived(retrievedAuthToken: String?, onSuccess: ((String?) -> Void)?) {
+        pendingAuth = false
+        
         authToken = retrievedAuthToken
 
         storeAuthToken()

tests/swift-sdk-swift-tests/AuthTests.swift

@@ -614,7 +614,7 @@ class AuthTests: XCTestCase {
                                         onSuccess: { token in
                                             XCTAssertEqual(token, AuthTests.authToken)
                                             condition1.fulfill()
-        })
+                                        })
 
         wait(for: [condition1], timeout: testExpectationTimeout)
     }
@@ -665,6 +665,44 @@ class AuthTests: XCTestCase {
         wait(for: [condition2], timeout: testExpectationTimeoutForInverted)
     }
 
+    func testRefreshTimerQueueRejection() {
+        let condition1 = expectation(description: "\(#function) - first refresh timer never happened called")
+        let condition2 = expectation(description: "\(#function) - second refresh timer should not have been called")
+        condition2.isInverted = true
+        
+        class AsyncAuthDelegate: IterableAuthDelegate {
+            func onAuthTokenRequested(completion: @escaping AuthTokenRetrievalHandler) {
+                DispatchQueue.main.asyncAfter(deadline: .now() + 3) {
+                    completion(AuthTests.authToken)
+                }
+            }
+        }
+        
+        let authDelegate = AsyncAuthDelegate()
+        
+        let config = IterableConfig()
+        config.authDelegate = authDelegate
+        
+        let authManager = AuthManager(delegate: config.authDelegate,
+                                      expirationRefreshPeriod: config.expiringAuthTokenRefreshPeriod,
+                                      localStorage: MockLocalStorage(),
+                                      dateProvider: MockDateProvider())
+        
+        authManager.requestNewAuthToken(hasFailedPriorAuth: false,
+                                        onSuccess: { token in
+                                            XCTAssertEqual(token, AuthTests.authToken)
+                                            condition1.fulfill()
+                                        })
+        
+        authManager.requestNewAuthToken(hasFailedPriorAuth: false,
+                                        onSuccess: { token in
+                                            condition2.fulfill()
+                                        })
+        
+        wait(for: [condition1], timeout: testExpectationTimeout)
+        wait(for: [condition2], timeout: 3)
+    }
+    
     // MARK: - Private
 
     class DefaultAuthDelegate: IterableAuthDelegate {