🧪 Added tests to validate JWT refresh on 401s

Author: joaodordio

swift-sdk/Internal/in-app/InAppHelper.swift

@@ -10,11 +10,13 @@ import UIKit
 struct InAppHelper {
     static func getInAppMessagesFromServer(apiClient: ApiClientProtocol,
                                            authManager: IterableAuthManagerProtocol?,
-                                           number: Int) -> Pending<[IterableInAppMessage], SendRequestError> {
+                                           number: Int,
+                                           successHandler onSuccess: OnSuccessHandler? = nil,
+                                           failureHandler onFailure: OnFailureHandler? = nil) -> Pending<[IterableInAppMessage], SendRequestError> {
 
         RequestProcessorUtil.sendRequest(requestProvider: { apiClient.getInAppMessages(NSNumber(value: number)) },
-                                         successHandler: nil,
-                                         failureHandler: nil,
+                                         successHandler: onSuccess,
+                                         failureHandler: onFailure,
                                          authManager: authManager,
                                          requestIdentifier: "getInAppMessages")
         .map {

tests/common/MockAuthManager.swift

@@ -10,11 +10,20 @@ import Foundation
 
 class MockAuthManager: IterableAuthManagerProtocol {
 
+    var token = "AuthToken"
+    
     var shouldRetry = true
     var retryWasRequested = false
+    var isLastAuthTokenValid = false
+    var pauseAuthRetries = false
+    var handleAuthFailureCalled = false
+    var getNextRetryIntervalCalled = false
+    var failedAuthCount = 0
 
     func handleAuthFailure(failedAuthToken: String?, reason: IterableSDK.AuthFailureReason) {
-        
+        failedAuthCount += 1
+        handleAuthFailureCalled = true
+        print("AuthManager handleAuthFailure with reason: \(reason.rawValue) and token: \(String(describing: failedAuthToken))")
     }
 
     func requestNewAuthToken(hasFailedPriorAuth: Bool, onSuccess: ((String?) -> Void)?, shouldIgnoreRetryPolicy: Bool) {
@@ -31,32 +40,37 @@ class MockAuthManager: IterableAuthManagerProtocol {
     }
 
     func scheduleAuthTokenRefreshTimer(interval: TimeInterval, isScheduledRefresh: Bool, successCallback: IterableSDK.AuthTokenRetrievalHandler?) {
-        requestNewAuthToken(hasFailedPriorAuth: false, onSuccess: successCallback, shouldIgnoreRetryPolicy: true)
+        requestNewAuthToken(hasFailedPriorAuth: false, onSuccess: { newToken in
+            guard let newToken else { return }
+            self.setNewToken(newToken)
+            successCallback?(newToken)
+        }, shouldIgnoreRetryPolicy: true)
     }
 
     func pauseAuthRetries(_ pauseAuthRetry: Bool) {
-        
+        pauseAuthRetries = pauseAuthRetry
     }
 
     func setIsLastAuthTokenValid(_ isValid: Bool) {
-        
+        isLastAuthTokenValid = isValid
     }
 
     func getNextRetryInterval() -> Double {
+        getNextRetryIntervalCalled = true
         return 0
     }
 
 
     func getAuthToken() -> String? {
-        return "AuthToken"
+        token
     }
 
     func resetFailedAuthCount() {
-
+        failedAuthCount = 0
     }
 
     func setNewToken(_ newToken: String) {
-
+        token = newToken
     }
 
     func logoutUser() {

tests/unit-tests/InAppHelperTests.swift

@@ -6,6 +6,30 @@ import XCTest
 
 @testable import IterableSDK
 
+private final class RetryingApiClient: BlankApiClient {
+    var numOfMessages = 3
+    var callCount = -1
+    var lastCountRequested: NSNumber?
+    var failureReason = "jwt token is expired"
+    weak var authManager: MockAuthManager?
+    
+    override func getInAppMessages(_ count: NSNumber) -> Pending<SendRequestValue, SendRequestError> {
+        callCount += 1
+        lastCountRequested = count
+        
+        if callCount == 0 {
+            return Fulfill(value: TestInAppPayloadGenerator.createPayloadWithUrl(numMessages: numOfMessages))
+        }
+        
+        if authManager?.retryWasRequested == true {
+            return Fulfill(value: TestInAppPayloadGenerator.createPayloadWithUrl(numMessages: numOfMessages))
+        }
+        return Fulfill(error: SendRequestError(reason: failureReason,
+                                               httpStatusCode: 401,
+                                               iterableCode: JsonValue.Code.invalidJwtPayload))
+    }
+}
+
 class InAppHelperTests: XCTestCase {
     func testGetInAppMessagesWithNoError() {
         class MyApiClient: BlankApiClient {
@@ -76,7 +100,49 @@ class InAppHelperTests: XCTestCase {
 
         wait(for: [expectation1], timeout: testExpectationTimeout)
     }
-    
+
+    func testGetInAppMessagesRetriesAfterJWT401() {
+        let authManager = MockAuthManager()
+        authManager.shouldRetry = true
+        
+        let apiClient = RetryingApiClient()
+        apiClient.authManager = authManager
+        
+        
+        let initialFailedAuthCount = authManager.failedAuthCount
+        
+        InAppHelper.getInAppMessagesFromServer(apiClient: apiClient,
+                                               authManager: authManager,
+                                               number: apiClient.numOfMessages).onSuccess { messages in
+            print(messages)
+        }.onError { error in
+            XCTFail("expected success, got error: \(error)")
+        }
+        
+        InAppHelper.getInAppMessagesFromServer(apiClient: apiClient,
+                                               authManager: authManager,
+                                               number: apiClient.numOfMessages,
+                                               successHandler: { data in
+            XCTAssertTrue(authManager.handleAuthFailureCalled)
+            XCTAssertTrue(authManager.getNextRetryIntervalCalled)
+            
+            XCTAssertTrue(authManager.retryWasRequested)
+            XCTAssertEqual(authManager.getAuthToken(), "newAuthToken")
+        }).onSuccess { messages in
+            print(messages)
+        }.onError { error in
+            XCTFail("expected success, got error: \(error)")
+        }
+        
+        InAppHelper.getInAppMessagesFromServer(apiClient: apiClient,
+                                               authManager: authManager,
+                                               number: apiClient.numOfMessages).onSuccess { messages in
+            XCTAssertTrue(authManager.retryWasRequested)
+        }.onError { error in
+            XCTFail("expected success, got error: \(error)")
+        }
+    }
+
     func testParseURL() {
         let urlWithNoScheme = URL(string: "blah")!
         XCTAssertNil(InAppHelper.parse(inAppUrl: urlWithNoScheme))