Allowing opened push event to be transmitted when SDK is not initialized #181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ajaysubra
commented
May 30, 2024
ajaysubra
commented
May 30, 2024
| @@ -116,7 +116,7 @@ class StateManagementEdgeCaseTests: XCTestCase { | |||
| // MARK: - Set Email | |||
|
|
|||
| @MainActor | |||
| func testSetEmailUninitialized() async throws { | |||
There was a problem hiding this comment.
Just updated some test names to indicate the outcome we expect
ajaysubra
commented
May 30, 2024
| } | ||
|
|
||
| @MainActor | ||
| func testEnqueueNonOpenedPushEventUninitializedDoesNotAddToPendingRequest() async throws { |
There was a problem hiding this comment.
This test goes through all other event metrics other than opened push and makes sure that they don't get through the SDK when it's not initialized.
ajaysubra
commented
May 30, 2024
| @@ -369,15 +369,30 @@ class StateManagementEdgeCaseTests: XCTestCase { | |||
| // MARK: - set enqueue event uninitialized | |||
|
|
|||
| @MainActor | |||
| func testEnqueueEventUninitialized() async throws { | |||
| func testOpenedPushEventUninitializedAddsToPendingRequests() async throws { | |||
There was a problem hiding this comment.
Tests opened push event is added to pending requests when SDK isn't initialized.
evan-masseau
approved these changes
May 30, 2024
ndurell
approved these changes
May 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Background
The SDK can be in three states of initialization -
The issue with react native is that by the time react native is booted from the native code the opened event request has already hit our SDK and the SDK is in the un-initialized state so the request is simply ignored. This logic has been in place since Dec 2023 on iOS and is part of requirement at that point and also now that developers should always initialize the SDK before interacting with it. When we implemented initialize in react native we didn't test this edge case.
While we still want our devs to initialize the SDK before calling any of it's methods. As long as they stick to interfacing with the SDK on just one of the layers (native or RN) they shouldn't encounter any issues. There is an exception to this with calling the SDK when a user opens push and this has to happen on the native side because of the application delegation pattern on iOS.
We want to keep the SDK simple in terms of logic and not queue up things which we don't know which company it belong to. For instance, if we allow devs to set profile and then initialize there is a chance that the profile wasn't intended to be associated with the company that was set later. In short, it keeps us from making too many assumptions on the SDK.
Finally, since we are the ones queueing up the opened push event when the devs calls our SDK to handle a push opened action from the user, it seems reasonable make an exception just in this case since we know for react native it is possible that the SDK may not be initialized in time to handle sending opened push event.
Solution
When the SDK is un-initialized and receives an opened push event, keep it in state until the SDK is initialized and then queue it up.
Check List
Manual Test Plan