Unit tests for UserExecutor with identity verification on

Author: emawby

iOS_SDK/OneSignalSDK/OneSignalUserMocks/MockUserDefines.swift

@@ -5,3 +5,5 @@ public let userB_OSID = "test_user_b_onesignal_id"
 public let userB_EUID = "test_user_b_external_id"
 
 public let testPushSubId = "test_push_subscription_id"
+
+public let userA_JwtToken = "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIwMTM5YmQ2Zi00NTFmLTQzOGMtODg4Ni00ZTBmMGZlM2EwODUiLCJleHAiOjE3MjUzOTY3NTksImlkZW50aXR5Ijp7ImV4dGVybmFsX2lkIjoiZWxsaW90MTE0MCJ9LCJzdWJzY3JpcHRpb25zIjpbeyJ0eXBlIjoiRW1haWwiLCJ0b2tlbiI6InRlc3RAZG9tYWluLmNvbSJ9LHsidHlwZSI6IlNNUyIsInRva2VuIjoiKzEyMzQ1Njc4In1dfQ.wmtt8mH7wYpxmUDyx_l8ktfF4Eg-6y_4iOSsIEl3AxuQ5pEriCIRj-3P-NmSPO3jsSAGPeBRZQ-rRS5j-LbN1w"

iOS_SDK/OneSignalSDK/OneSignalUserMocks/MockUserRequests.swift

@@ -59,6 +59,14 @@ public class MockUserRequests: NSObject {
             "properties": properties
         ]
     }
+    
+    public static func testUnauthorizedailureError() -> NSError {
+        let userInfo = ["returned": [
+            "errors": [["title":"token has invalid claims: token is expired", "code":"auth-0"]],
+            "httpStatusCode": 401,
+        ]]
+        return NSError(domain: "not-important", code: 401, userInfo: userInfo)
+    }
 }
 
 // MARK: - Set Up Default Client Responses
@@ -97,6 +105,16 @@ extension MockUserRequests {
             response: userResponse
         )
     }
+    
+    public static func setUnauthorizedCreateUserFailureResponses(with client: MockOneSignalClient, externalId: String) {
+        let error = testUnauthorizedailureError()
+        client.setMockFailureResponseForRequest(request:"<OSRequestCreateUser with external_id: \(externalId)>", error: error)
+    }
+    
+    public static func setUnauthorizedFetchUserFailureResponses(with client: MockOneSignalClient, onesignalId: String) {
+        let error = testUnauthorizedailureError()
+        client.setMockFailureResponseForRequest(request:"<OSRequestFetchUser with onesignal_id: \(onesignalId)>", error: error)
+    }
 
     public static func setDefaultIdentifyUserResponses(with client: MockOneSignalClient, externalId: String, conflicted: Bool = false) {
         var osid: String

iOS_SDK/OneSignalSDK/OneSignalUserTests/Executors/UserExecutorTests.swift

@@ -207,4 +207,131 @@ final class UserExecutorTests: XCTestCase {
         XCTAssertTrue(mocks.client.hasExecutedRequestOfType(OSRequestCreateUser.self))
         XCTAssertTrue(mocks.newRecordsState.records.isEmpty)
     }
+    
+    func testCreateUser_IdentityVerificationRequired_butNoToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: "")
+        let newIdentityModel = OSIdentityModel(aliases: [OS_EXTERNAL_ID: userA_EUID], changeNotifier: OSEventProducer())
+        MockUserRequests.setDefaultCreateUserResponses(with: mocks.client, externalId: userA_EUID)
+        
+        /* When */
+        mocks.userExecutor.createUser(aliasLabel: OS_EXTERNAL_ID, aliasId: userA_EUID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should not execute this request since identity verification is required, but no token was set
+        XCTAssertFalse(mocks.client.hasExecutedRequestOfType(OSRequestCreateUser.self))
+        XCTAssertEqual(mocks.newRecordsState.records.count, 0)
+    }
+    
+    func testCreateUser_IdentityVerificationRequired_withToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: "")
+        let newIdentityModel = OSIdentityModel(aliases: [OS_EXTERNAL_ID: userA_EUID], changeNotifier: OSEventProducer())
+        newIdentityModel.jwtBearerToken = userA_JwtToken
+        MockUserRequests.setDefaultCreateUserResponses(with: mocks.client, externalId: userA_EUID)
+        
+        /* When */
+        mocks.userExecutor.createUser(aliasLabel: OS_EXTERNAL_ID, aliasId: userA_EUID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should execute this request since identity verification is required and the token was set
+        XCTAssertTrue(mocks.client.hasExecutedRequestOfType(OSRequestCreateUser.self))
+    }
+    
+    func testCreateUser_IdentityVerificationRequired_withInvalidToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: userA_EUID)
+        let newIdentityModel = OSIdentityModel(aliases: [OS_EXTERNAL_ID: userA_EUID], changeNotifier: OSEventProducer())
+        newIdentityModel.jwtBearerToken = userA_JwtToken
+        MockUserRequests.setUnauthorizedCreateUserFailureResponses(with: mocks.client, externalId: userA_EUID)
+        
+        var invalidatedCallbackWasCalled = false
+        OneSignalUserManagerImpl.sharedInstance.User.onJwtInvalidated { event in
+            XCTAssertTrue(event.message == "token has invalid claims: token is expired")
+            invalidatedCallbackWasCalled = true
+        }
+        
+        /* When */
+        mocks.userExecutor.createUser(aliasLabel: OS_EXTERNAL_ID, aliasId: userA_EUID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should execute this request since identity verification is required and the token was set
+        XCTAssertTrue(mocks.client.hasExecutedRequestOfType(OSRequestCreateUser.self))
+        XCTAssertTrue(invalidatedCallbackWasCalled)
+    }
+    
+    func testFetchUser_IdentityVerificationRequired_butNoToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: "")
+        let newIdentityModel = OSIdentityModel(aliases: [OS_ONESIGNAL_ID: userA_OSID], changeNotifier: OSEventProducer())
+        MockUserRequests.setDefaultFetchUserResponseForHydration(with: mocks.client, externalId: userA_EUID)
+        
+        /* When */
+        mocks.userExecutor.fetchUser(onesignalId: userA_OSID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should not execute this request since identity verification is required, but no token was set
+        XCTAssertFalse(mocks.client.hasExecutedRequestOfType(OSRequestFetchUser.self))
+    }
+    
+    func testFetchUser_IdentityVerificationRequired_withToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: "")
+        let newIdentityModel = OSIdentityModel(aliases: [OS_ONESIGNAL_ID: userA_OSID, OS_EXTERNAL_ID: userA_EUID], changeNotifier: OSEventProducer())
+        newIdentityModel.jwtBearerToken = userA_JwtToken
+        MockUserRequests.setDefaultFetchUserResponseForHydration(with: mocks.client, externalId: userA_EUID)
+        
+        /* When */
+        mocks.userExecutor.fetchUser(onesignalId: userA_OSID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should not execute this request since identity verification is required, but no token was set
+        XCTAssertTrue(mocks.client.hasExecutedRequestOfType(OSRequestFetchUser.self))
+    }
+    
+    func testFetchUser_IdentityVerificationRequired_withInvalidToken() {
+        /* Setup */
+        let mocks = Mocks()
+        mocks.setAuthRequired(true)
+        
+        let _ = mocks.setUserManagerInternalUser(externalId: userA_EUID)
+        let newIdentityModel = OSIdentityModel(aliases: [OS_ONESIGNAL_ID: userA_OSID, OS_EXTERNAL_ID: userA_EUID], changeNotifier: OSEventProducer())
+        newIdentityModel.jwtBearerToken = userA_JwtToken
+        MockUserRequests.setUnauthorizedFetchUserFailureResponses(with: mocks.client, onesignalId: userA_OSID)
+        
+        var invalidatedCallbackWasCalled = false
+        OneSignalUserManagerImpl.sharedInstance.User.onJwtInvalidated { event in
+            XCTAssertTrue(event.message == "token has invalid claims: token is expired")
+            invalidatedCallbackWasCalled = true
+        }
+        
+        /* When */
+        mocks.userExecutor.fetchUser(onesignalId: userA_OSID, identityModel: newIdentityModel)
+        OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5)
+        
+        /* Then */
+        // The executor should execute this request since identity verification is required and the token was set
+        XCTAssertTrue(mocks.client.hasExecutedRequestOfType(OSRequestFetchUser.self))
+        XCTAssertTrue(invalidatedCallbackWasCalled)
+    }
 }