|
| 1 | +/* |
| 2 | + Modified MIT License |
| 3 | + |
| 4 | + Copyright 2025 OneSignal |
| 5 | + |
| 6 | + Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + of this software and associated documentation files (the "Software"), to deal |
| 8 | + in the Software without restriction, including without limitation the rights |
| 9 | + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + copies of the Software, and to permit persons to whom the Software is |
| 11 | + furnished to do so, subject to the following conditions: |
| 12 | + |
| 13 | + 1. The above copyright notice and this permission notice shall be included in |
| 14 | + all copies or substantial portions of the Software. |
| 15 | + |
| 16 | + 2. All copies of substantial portions of the Software may only be used in connection |
| 17 | +with services provided by OneSignal. |
| 18 | + |
| 19 | + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 25 | + THE SOFTWARE. |
| 26 | + */ |
| 27 | + |
| 28 | +import XCTest |
| 29 | +import OneSignalOSCore |
| 30 | +import OneSignalCoreMocks |
| 31 | +import OneSignalOSCoreMocks |
| 32 | +import OneSignalUserMocks |
| 33 | +@testable import OneSignalUser |
| 34 | + |
| 35 | +/** |
| 36 | + Tests for OSMessagingController's user state observer functionality. |
| 37 | + |
| 38 | + These tests verify that IAM fetching is retried when the OneSignal ID becomes available |
| 39 | + after an initial fetch attempt fails due to missing OneSignal ID during early app startup. |
| 40 | + |
| 41 | + Related to PR: https://github.com/OneSignal/OneSignal-iOS-SDK/pull/1626 |
| 42 | + */ |
| 43 | +final class OSMessagingControllerUserStateTests: XCTestCase { |
| 44 | + |
| 45 | + private let testSubscriptionId = "test-subscription-id-12345" |
| 46 | + private let testOneSignalId = "test-onesignal-id-12345" |
| 47 | + private let testExternalId = "test-external-id-12345" |
| 48 | + private let testAppId = "test-app-id" |
| 49 | + |
| 50 | + override func setUpWithError() throws { |
| 51 | + OneSignalCoreMocks.clearUserDefaults() |
| 52 | + OneSignalUserMocks.reset() |
| 53 | + OSConsistencyManager.shared.reset() |
| 54 | + |
| 55 | + // Set up basic configuration |
| 56 | + OneSignalConfigManager.setAppId(testAppId) |
| 57 | + OneSignalLog.setLogLevel(.LL_VERBOSE) |
| 58 | + } |
| 59 | + |
| 60 | + override func tearDownWithError() throws { |
| 61 | + OSMessagingController.removeInstance() |
| 62 | + } |
| 63 | + |
| 64 | + /** |
| 65 | + Test that when getInAppMessagesFromServer is called without a OneSignal ID, it stores the subscription ID for later retry. |
| 66 | + |
| 67 | + Scenario: |
| 68 | + - User calls initialize() and login() early in app startup |
| 69 | + - Push subscription ID is available but OneSignal ID is not yet set |
| 70 | + - IAM fetch should be deferred |
| 71 | + |
| 72 | + Expected: |
| 73 | + - shouldFetchOnUserChangeWithSubscriptionID property is set with the subscription ID |
| 74 | + - No IAM fetch actually occurs |
| 75 | + */ |
| 76 | + func testStoresSubscriptionIDWhenOneSignalIDUnavailable() throws { |
| 77 | + /* Setup */ |
| 78 | + let client = MockOneSignalClient() |
| 79 | + OneSignalCoreImpl.setSharedClient(client) |
| 80 | + |
| 81 | + // Note: nothing has set OneSignal ID |
| 82 | + |
| 83 | + /* Execute */ |
| 84 | + OneSignalInAppMessages.getFromServer(testSubscriptionId) |
| 85 | + OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5) |
| 86 | + |
| 87 | + /* Verify */ |
| 88 | + // The controller should have stored the subscription ID for retry |
| 89 | + let shouldFetchOnUserChangeWithSubscriptionID = OSMessagingController.sharedInstance().value(forKey: "shouldFetchOnUserChangeWithSubscriptionID") |
| 90 | + XCTAssertEqual(shouldFetchOnUserChangeWithSubscriptionID as! String, testSubscriptionId) |
| 91 | + |
| 92 | + // Verify no IAM request was actually made (since we don't have OneSignal ID) |
| 93 | + XCTAssertTrue(client.hasExecutedRequestOfType(OSRequestGetInAppMessages.self, expectedCount: 0)) |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + Test that when user state changes with a valid OneSignal ID and shouldFetchOnUserChangeWithSubscriptionID is set, it retries the fetch. |
| 98 | + |
| 99 | + Scenario: |
| 100 | + - IAM fetch was previously deferred due to missing OneSignal ID |
| 101 | + - User response is returned and OneSignal ID becomes available |
| 102 | + - User state change observer is triggered |
| 103 | + |
| 104 | + Expected: |
| 105 | + - IAM fetch is retried with the stored subscription ID |
| 106 | + - shouldFetchOnUserChangeWithSubscriptionID is cleared |
| 107 | + */ |
| 108 | + func testRetriesFetchWhenUserStateChangesWithValidOneSignalID() throws { |
| 109 | + /* Setup */ |
| 110 | + let client = MockOneSignalClient() |
| 111 | + OneSignalCoreImpl.setSharedClient(client) |
| 112 | + OSMessagingController.start() |
| 113 | + let controller = OSMessagingController.sharedInstance() |
| 114 | + |
| 115 | + // Unblock consistency manager |
| 116 | + ConsistencyManagerTestHelpers.setDefaultRywToken(id: testOneSignalId) |
| 117 | + |
| 118 | + /* Execute */ |
| 119 | + // Setup the anonymous user |
| 120 | + MockUserRequests.setDefaultCreateAnonUserResponses(with: client, onesignalId: testOneSignalId, subscriptionId: testSubscriptionId) |
| 121 | + OneSignalUserManagerImpl.sharedInstance.start() |
| 122 | + |
| 123 | + // Login to a new user, without setting the client response, so onesignal ID is not hydrated |
| 124 | + OneSignalUserManagerImpl.sharedInstance.login(externalId: testExternalId, token: nil) |
| 125 | + |
| 126 | + // First attempt: Try to fetch IAMs without OneSignal ID (should be deferred) |
| 127 | + OneSignalInAppMessages.getFromServer(testSubscriptionId) |
| 128 | + OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5) |
| 129 | + |
| 130 | + // Verify the subscription ID was stored and no IAM fetch occurred |
| 131 | + XCTAssertEqual(controller.value(forKey: "shouldFetchOnUserChangeWithSubscriptionID") as! String, testSubscriptionId) |
| 132 | + XCTAssertTrue(client.hasExecutedRequestOfType(OSRequestGetInAppMessages.self, expectedCount: 0)) |
| 133 | + |
| 134 | + // Now let the login succeed, receive onesignal ID which fires user state observer |
| 135 | + MockUserRequests.setDefaultIdentifyUserResponses(with: client, externalId: testExternalId) |
| 136 | + OneSignalUserManagerImpl.sharedInstance.userExecutor?.userRequestQueue.first?.sentToClient = false |
| 137 | + OneSignalUserManagerImpl.sharedInstance.userExecutor?.executePendingRequests() |
| 138 | + OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5) |
| 139 | + |
| 140 | + /* Verify */ |
| 141 | + // The fetch should have been retried now that OneSignal ID is available |
| 142 | + XCTAssertTrue(client.hasExecutedRequestOfType(OSRequestGetInAppMessages.self, expectedCount: 1)) |
| 143 | + |
| 144 | + // The stored subscription ID should be cleared after successful retry |
| 145 | + XCTAssertNil(controller.value(forKey: "shouldFetchOnUserChangeWithSubscriptionID")) |
| 146 | + } |
| 147 | + |
| 148 | + /** |
| 149 | + Test that when user state changes but shouldFetchOnUserChangeWithSubscriptionID is not set, it does nothing. |
| 150 | + |
| 151 | + Scenario: |
| 152 | + - Normal user state change occurs |
| 153 | + - No deferred fetch was pending |
| 154 | + |
| 155 | + Expected: |
| 156 | + - No retry logic is triggered |
| 157 | + - Normal operation continues |
| 158 | + */ |
| 159 | + func testDoesNothingWhenNoRetryPending() throws { |
| 160 | + /* Setup */ |
| 161 | + let client = MockOneSignalClient() |
| 162 | + OneSignalCoreImpl.setSharedClient(client) |
| 163 | + OneSignalInAppMessages.start() |
| 164 | + let controller = OSMessagingController.sharedInstance() |
| 165 | + |
| 166 | + // Set up user with valid OneSignal ID from the start |
| 167 | + MockUserRequests.setDefaultCreateAnonUserResponses( |
| 168 | + with: client, |
| 169 | + onesignalId: testOneSignalId, |
| 170 | + subscriptionId: testSubscriptionId |
| 171 | + ) |
| 172 | + ConsistencyManagerTestHelpers.setDefaultRywToken(id: testOneSignalId) |
| 173 | + OneSignalUserManagerImpl.sharedInstance.start() |
| 174 | + OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5) |
| 175 | + |
| 176 | + /* Verify */ |
| 177 | + // IAM is fetched and no retry is pending |
| 178 | + XCTAssertTrue(client.hasExecutedRequestOfType(OSRequestGetInAppMessages.self, expectedCount: 1)) |
| 179 | + XCTAssertNil(controller.value(forKey: "shouldFetchOnUserChangeWithSubscriptionID")) |
| 180 | + |
| 181 | + /* Execute */ |
| 182 | + // Trigger a normal user state change by login |
| 183 | + MockUserRequests.setDefaultIdentifyUserResponses(with: client, externalId: testExternalId) |
| 184 | + OneSignalUserManagerImpl.sharedInstance.login(externalId: testExternalId, token: nil) |
| 185 | + OneSignalCoreMocks.waitForBackgroundThreads(seconds: 0.5) |
| 186 | + |
| 187 | + /* Verify */ |
| 188 | + // Does not fetch IAMs again |
| 189 | + XCTAssertTrue(client.hasExecutedRequestOfType(OSRequestGetInAppMessages.self, expectedCount: 1)) |
| 190 | + } |
| 191 | +} |
0 commit comments