chore: improve reliability dismissing modal messages on page rule change #732
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
Part of: https://linear.app/customerio/issue/MBL-355/ios-fix-in-app-message-displayed-on-wrong-page There is a scenario where a modal message can be displayed on the wrong screen due to a timing issue. Although the time window where this could happen is small, it was encountered during QA testing. Test case to reproduce: * In-app message with page rule "Dashboard" sent to device. User on "Dashboard" screen. In-app message begins to render. * Similar to what is explained [here](https://customerio.slack.com/archives/C06H7MMLH6C/p1716391939537599), if the user of the app clicks a button to begin navigating to another screen in the app and the modal message finishes rendering during the screen transition animation, the modal will be displayed and will remain displayed after the animation is complete and the next screen is shown. Solution: Dismiss the modal when the screen transition animation ends and a new page rule is triggered. Ensure that when a Modal message is shown, it does not trigger an automatic screenview event. This allows the SDK to recognize user navigation to a new screen accurately. Testing: * Automated tests added to verify auto screenview tracking. * QA test verified that when a Gist Modal message shown, an automatic screenview event not tracked.
Sample app builds 📱Below you will find the list of the latest versions of the sample apps. It's recommended to always download the latest builds of the sample apps to accurately test the pull request.
|
SDK binary size reports 📊SDK binary size of this PRSDK binary size diff report between this PR and the main branch |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## levi/inapp-strict-pagerules #732 +/- ##
===============================================================
+ Coverage 60.29% 60.50% +0.21%
===============================================================
Files 140 140
Lines 3926 3922 -4
===============================================================
+ Hits 2367 2373 +6
+ Misses 1559 1549 -10 ☔ View full report in Codecov by Sentry. |
This was referenced Jun 13, 2024
levibostian
added a commit
that referenced
this pull request
Jun 14, 2024
Part of: https://linear.app/customerio/issue/MBL-355/ios-fix-in-app-message-displayed-on-wrong-page After this PR, #732, if you close a modal message, it will not load the next one in the local queue. This PR brings this feature back by checking the local queue after a message is closed. Testing * Added automated tests. However, the added tests fail because of asynchronous code needing to run. I rebased this commit on top of PR (#738) and tests all ran and passed as expected. To not block this PR from getting merged and shipped, the automated tests are skipped in this PR. Once we merge in the synchronous changes, we can re-enable the tests.
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.
Part of: https://linear.app/customerio/issue/MBL-355/ios-fix-in-app-message-displayed-on-wrong-page
There is a scenario where a modal message can be displayed on the wrong screen due to a timing issue. Although the time window where this could happen is small, it was encountered during QA testing.
Test case to reproduce:
Solution:
Dismiss the modal when the screen transition animation ends and a new page rule is triggered. Ensure that when a Modal message is shown, it does not trigger an automatic screenview event. This allows the SDK to recognize user navigation to a new screen accurately.
Testing:
Based on PR #731
Full chain of PRs as of 2024-06-14
levi/ignore-cio-autoscreenviews➔levi/inapp-strict-pageruleslevi/inapp-strict-pagerules➔main