Android: fix GetMissingOnyxUpdates in the background #40022

arosiclair · 2024-04-10T15:58:48Z

Details

Fixes an issue with our background process on Android quitting before onyx updates can finish processing in the background. This is accomplished by

Returning a promise from our push notification handler so that the background process does not quit until it is resolved
Moving reliable updates code to handleOnyxUpdateGap() and running it synchronously
Using another promise to read lastUpdateIDAppliedToClient from Onyx since other Onyx.connect callbacks do not run in the background

Additionally, OnyxUpdates.applyOnyxUpdatesReliably was moved to it's own lib to avoid a dependency cycle between OnyxUpdates.ts and OnyxUpdateManager.ts

Fixed Issues

$ #39544
PROPOSAL: #39544 (comment)

Tests

Log in as two workspace members on web and Android
Create a room and add both members
As the Android user, mute notifications in the room and kill the app
As the web user, send a few messages in the room (this creates missed onyx updates)
As the web user, send a DM to the Android user
View logs on Android
Verify a push notification is received for the message
Verify the app wakes and prints the following logs (it may take a minute)

[PushNotification] received report comment notification in the background - {"reportID":1474964742089670,"reportActionID":"4154791159330725517"}

[PushNotification] reliable onyx update received - {"lastUpdateID":5835,"previousUpdateID":5833,"onyxDataCount":2}

Gap detected in update IDs from server so fetching incremental updates - {"lastUpdateIDFromServer":5835,"previousUpdateIDFromServer":5833,"lastUpdateIDFromClient":5828}

Making API request - {"command":"GetMissingOnyxMessages"}

[OnyxUpdateManager] Done applying all updates

Offline tests

None

QA Steps

None

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…pdates

arosiclair · 2024-04-12T19:54:44Z

This is nearly ready however there are some changes to the OnyxUpdateManager being prepared in #fireroom-2024-04-01-chats-do-not-load that will cause some conflicts so I'll hold until those are done.

…round-missing-updates

melvin-bot · 2024-04-15T15:04:11Z

@getusha Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

eh2077 · 2024-04-16T09:16:58Z

We have another related ongoing PR here #39683

arosiclair · 2024-04-16T13:35:04Z

We have another related ongoing PR here #39683

Thanks for the heads up that will probably cause some conflicts. I'm not sure which should be merged first. This one is ready to go though.

danieldoglas · 2024-04-16T13:40:12Z

We can merge this one first. The other one is more risky

arosiclair · 2024-04-16T13:49:12Z

Feel free to review if you're available @rushatgabhane

rushatgabhane · 2024-04-16T14:50:58Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

WhatsApp.Video.2024-04-17.at.21.19.02.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rushatgabhane · 2024-04-16T20:05:09Z

sorry im not receiving notifications on android dev build.

i tried

emulator
physical android - dev build
physical android - release build

asked for help here - https://expensify.slack.com/archives/C01GTK53T8Q/p1713298080966799

rushatgabhane

LGTM

melvin-bot · 2024-04-17T15:54:33Z

@grgia Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

grgia · 2024-04-19T13:12:12Z

src/libs/actions/OnyxUpdates.ts

@@ -132,29 +132,23 @@ function saveUpdateInformation(updateParams: OnyxUpdatesFromServer) {
 * This function will receive the previousUpdateID from any request/pusher update that has it, compare to our current app state
 * and return if an update is needed
 * @param previousUpdateID The previousUpdateID contained in the response object
+ * @param clientLastUpdateID an optional override for the lastUpdateIDAppliedToClient


What's the purpose of this change?

I explained in the description above. In the background, Onyx.connect in this module doesn't run so we need to pass the value for lastUpdateIDAppliedToClient as a param.

grgia · 2024-04-19T13:12:56Z

src/libs/actions/User.ts

@@ -597,7 +597,7 @@ function subscribeToUserEvents() {
            updates: pushJSON.updates ?? [],
            previousUpdateID: Number(pushJSON.previousUpdateID || 0),
        };
-        OnyxUpdates.applyOnyxUpdatesReliably(updates);
+        applyOnyxUpdatesReliably(updates);


I'm just curious: why'd we move this into its own file?

Also explained in the description 😄

OSBotify · 2024-04-19T14:37:47Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-04-23T23:42:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Beamanator · 2024-05-14T11:11:50Z

src/libs/actions/OnyxUpdateManager.ts

+        // When ONYX_UPDATES_FROM_SERVER is set, we pause the queue. Let's unpause
+        // it so the app is not stuck forever without processing requests.
+        SequentialQueue.unpause();
+        console.debug(`[OnyxUpdateManager] Ignoring Onyx updates while OpenApp hans't finished yet.`);


*hasn't 🤷

return promises from push notification callbacks

994ea52

arosiclair self-assigned this Apr 10, 2024

arosiclair added 7 commits April 10, 2024 12:20

optionally handle onyx update gaps synchronously

37b4241

fix dependency cycle

9e0ef4b

apply reliable update synchronously

dc7ceb2

simplify promise

9f56daf

add optional clientLastUpdateID to override lastUpdateIDAppliedToClient

7367ef3

manually read lastUpdateIDAppliedToClient from onyx before applying u…

89b0c3f

…pdates

use consistent naming

f62e13b

Merge branch 'main' of github.com:Expensify/App into arosiclair-backg…

ef8286f

…round-missing-updates

arosiclair marked this pull request as ready for review April 15, 2024 15:04

arosiclair requested a review from a team as a code owner April 15, 2024 15:04

melvin-bot bot removed the request for review from a team April 15, 2024 15:04

melvin-bot bot requested a review from getusha April 15, 2024 15:04

danieldoglas self-requested a review April 15, 2024 15:10

arosiclair requested a review from rushatgabhane April 16, 2024 13:47

rushatgabhane approved these changes Apr 17, 2024

View reviewed changes

melvin-bot bot requested a review from grgia April 17, 2024 15:54

grgia reviewed Apr 19, 2024

View reviewed changes

grgia approved these changes Apr 19, 2024

View reviewed changes

arosiclair merged commit 0ab574b into main Apr 19, 2024
21 of 22 checks passed

arosiclair deleted the arosiclair-background-missing-updates branch April 19, 2024 14:30

github-actions bot mentioned this pull request Apr 22, 2024

Deploy Checklist: New Expensify 2024-04-22 #40702

Closed

95 tasks

rushatgabhane mentioned this pull request Apr 28, 2024

HIGH: [API Reliability] Android: GetMissingOnyxMessages is not called in the background #39544

Closed

6 tasks

Beamanator reviewed May 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Android: fix GetMissingOnyxUpdates in the background #40022

Android: fix GetMissingOnyxUpdates in the background #40022

arosiclair commented Apr 10, 2024 •

edited

arosiclair commented Apr 12, 2024

melvin-bot bot commented Apr 15, 2024

eh2077 commented Apr 16, 2024 •

edited

arosiclair commented Apr 16, 2024

danieldoglas commented Apr 16, 2024

arosiclair commented Apr 16, 2024

rushatgabhane commented Apr 16, 2024 •

edited

rushatgabhane commented Apr 16, 2024 •

edited

rushatgabhane left a comment

melvin-bot bot commented Apr 17, 2024

grgia Apr 19, 2024

arosiclair Apr 19, 2024

grgia Apr 19, 2024

arosiclair Apr 19, 2024

OSBotify commented Apr 19, 2024

OSBotify commented Apr 23, 2024

Beamanator May 14, 2024

Android: fix GetMissingOnyxUpdates in the background #40022

Android: fix GetMissingOnyxUpdates in the background #40022

Conversation

arosiclair commented Apr 10, 2024 • edited

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

arosiclair commented Apr 12, 2024

melvin-bot bot commented Apr 15, 2024

eh2077 commented Apr 16, 2024 • edited

arosiclair commented Apr 16, 2024

danieldoglas commented Apr 16, 2024

arosiclair commented Apr 16, 2024

rushatgabhane commented Apr 16, 2024 • edited

Reviewer Checklist

Screenshots/Videos

rushatgabhane commented Apr 16, 2024 • edited

rushatgabhane left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Apr 17, 2024

grgia Apr 19, 2024

Choose a reason for hiding this comment

arosiclair Apr 19, 2024

Choose a reason for hiding this comment

grgia Apr 19, 2024

Choose a reason for hiding this comment

arosiclair Apr 19, 2024

Choose a reason for hiding this comment

OSBotify commented Apr 19, 2024

OSBotify commented Apr 23, 2024

Beamanator May 14, 2024

Choose a reason for hiding this comment

arosiclair commented Apr 10, 2024 •

edited

eh2077 commented Apr 16, 2024 •

edited

rushatgabhane commented Apr 16, 2024 •

edited

rushatgabhane commented Apr 16, 2024 •

edited