Add check if client is active before applying pusher updates #39990

danieldoglas · 2024-04-10T07:49:09Z

Details

Problem

When we have multiple tabs open on new dot, all of them receive pusher updates. That's causing confusion because we're trying to apply them all, so depending on the tab you are, you'll see that they were applied, or that we've skipped them because they were already applied (in another tab).
This is also a problem when you receive an update that you are not up to date. If that happens, we will trigger N calls to GetMissingOnyxMessages.

Alice's local lastUpdateID is 10, and she has 3 tabs open (A, B and C)
Alice receives updateID 11, with previousUpdateID 10
a. Tab A receives it first, so it applied the update
b. Tab B and Tab C will log Update received was older than or the same as current state, returning without applying the updates other than successData and failureData
Alice then receives update 15, with previousUpdateID 14
a. All 3 tabs will receive that update
b. All 3 tabs will call saveUpdateInformation after checking that the previousUpdateID do not match
c. Because we execute the call for GetMissingOnyxUpdate on a callback of updates on the key ONYX_UPDATES_FROM_SERVER, and we updated that key 3 times on 3.b, each tab will call GetMissingOnyxUpdates 3 times (for a total of 9 calls to our servers)

We've solved issue 3.c on PR #39943, but we were still doing 3 requests (because we triggered the call back 3 times). This PR is solving that.

Fixed Issues

$ #39992
$ https://github.com/Expensify/Expensify/issues/386379

Tests

Open the app in 2 separate tabs and open the console
Receive a message on the account logged in those tabs
Confirm you can find logs with but ignoring it since this is not the active client in one of the clients
Confirm that the message is visible in both clients
Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-10T07:49:14Z

@mollfpr 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]

Julesssss

I assume active client is the most recent tab or Desktop app? It seems like we already rely on this function and that it's not used for mobile 👍
Given this is relatively critical I'd suggest we get a C+ review

danieldoglas · 2024-04-10T08:19:28Z

I assume active client is the most recent tab or Desktop app?

Yes, most recent tab - in desktop/android/iOS this won't really matter since you'll always be on the most recent one. It also doesn't compare cross clients, only in the same client that shares the storage.

allroundexperts · 2024-04-10T08:21:34Z

Taking over!

allroundexperts · 2024-04-10T08:26:21Z

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

Android: mWeb Chrome

Screen.Recording.2024-04-10.at.2.07.00.PM.mov

iOS: Native

Screen.Recording.2024-04-10.at.2.46.01.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-10.at.1.58.28.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-10.at.1.45.10.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-10.at.1.55.57.PM.mov

Julesssss · 2024-04-10T08:48:08Z

Thanks for clarification, I was wondering if an edge-case would occur for internal users with Desktop prod and staging

danieldoglas · 2024-04-10T09:03:44Z

I was wondering if an edge-case would occur for internal users with Desktop prod and staging

It should not, since those clients will have separate storage

allroundexperts

Looks good!

melvin-bot · 2024-04-10T10:04:08Z

@johnmlee101 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]

Julesssss · 2024-04-10T10:10:42Z

Looks good!

Hey @allroundexperts, did you test multiple tabs for web/mWeb?

allroundexperts · 2024-04-10T10:13:06Z

@Julesssss yep:

321174966-10869b8f-0f59-4cd2-ad1d-abb1ef13c043.mov

Julesssss · 2024-04-10T10:14:17Z

It kinda looks like one dev tab, one staging tab to me

allroundexperts · 2024-04-10T10:15:20Z

It kinda looks like one dev tab, one staging tab to me

There are 3 tabs. Two dev, and 1 staging. The console log appears on the first tab, while second tab shows the message. At around 19th second, I'm switching back to the first tab (which was not active).

Julesssss · 2024-04-10T10:17:16Z

Ah thanks for the explanation 👍

OSBotify · 2024-04-10T10:26:34Z

✋ 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-10T17:48:33Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-10T17:57:26Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-10T19:36:39Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-18T04:34:24Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.62-17 🚀

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

arosiclair · 2024-05-08T16:33:58Z

src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.ts

@@ -30,6 +31,10 @@ Onyx.connect({
 */
 export default function subscribeToReportCommentPushNotifications() {
    PushNotification.onReceived(PushNotification.TYPE.REPORT_COMMENT, ({reportID, reportActionID, onyxData, lastUpdateID, previousUpdateID}) => {
+        if (!ActiveClientManager.isClientTheLeader()) {


Just an FYI, mobile is always the leader (there's only one client) so we'll never hit this code block

Ok. This is not creating a problem, right?

Nope just noticed this while refactoring. I'll probably remove it.

danieldoglas added 4 commits April 10, 2024 09:41

adding checks on pusher subscriptions

62f8e12

added check to urban airship notifications

917d5e4

adding log line

45268af

adding log lines

99eec24

danieldoglas self-assigned this Apr 10, 2024

danieldoglas requested a review from a team as a code owner April 10, 2024 07:49

melvin-bot bot requested review from mollfpr and removed request for a team April 10, 2024 07:49

prettier

7cd2871

danieldoglas removed the request for review from mollfpr April 10, 2024 07:57

Julesssss reviewed Apr 10, 2024

View reviewed changes

danieldoglas requested a review from allroundexperts April 10, 2024 08:24

allroundexperts approved these changes Apr 10, 2024

View reviewed changes

melvin-bot bot requested a review from johnmlee101 April 10, 2024 10:04

Julesssss approved these changes Apr 10, 2024

View reviewed changes

Julesssss merged commit 0995d40 into main Apr 10, 2024
18 of 20 checks passed

Julesssss deleted the dsilva_addCheckIfClientIsActiveForPusherUpdates branch April 10, 2024 10:17

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

Deploy Checklist: New Expensify 2024-04-10 #40026

Closed

melvin-bot bot mentioned this pull request Apr 18, 2024

[HOLD for payment 2024-04-25] GetMissinOnyxMessages being executed several times #39992

Closed

arosiclair reviewed May 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add check if client is active before applying pusher updates #39990

Add check if client is active before applying pusher updates #39990

danieldoglas commented Apr 10, 2024 •

edited

Loading

melvin-bot bot commented Apr 10, 2024

Julesssss left a comment •

edited

Loading

danieldoglas commented Apr 10, 2024

allroundexperts commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 •

edited

Loading

Julesssss commented Apr 10, 2024

danieldoglas commented Apr 10, 2024

allroundexperts left a comment

melvin-bot bot commented Apr 10, 2024

Julesssss commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 •

edited

Loading

Julesssss commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 •

edited

Loading

Julesssss commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 18, 2024

arosiclair May 8, 2024

danieldoglas May 8, 2024

arosiclair May 8, 2024

Add check if client is active before applying pusher updates #39990

Add check if client is active before applying pusher updates #39990

Conversation

danieldoglas commented Apr 10, 2024 • edited Loading

Details

Problem

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 10, 2024

Julesssss left a comment • edited Loading

Choose a reason for hiding this comment

danieldoglas commented Apr 10, 2024

allroundexperts commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Julesssss commented Apr 10, 2024

danieldoglas commented Apr 10, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Apr 10, 2024

Julesssss commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 • edited Loading

Julesssss commented Apr 10, 2024

allroundexperts commented Apr 10, 2024 • edited Loading

Julesssss commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 18, 2024

arosiclair May 8, 2024

Choose a reason for hiding this comment

danieldoglas May 8, 2024

Choose a reason for hiding this comment

arosiclair May 8, 2024

Choose a reason for hiding this comment

danieldoglas commented Apr 10, 2024 •

edited

Loading

Julesssss left a comment •

edited

Loading

allroundexperts commented Apr 10, 2024 •

edited

Loading

allroundexperts commented Apr 10, 2024 •

edited

Loading

allroundexperts commented Apr 10, 2024 •

edited

Loading