After revert: Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #39683

chrispader · 2024-04-05T06:19:51Z

@danieldoglas

Details

This PR applies back the changes from #38997 after the revert in #39668

This PR adds unit and E2E tests covering the OnyxUpdateManager and the new update deferral logic.

Fixed Issues

$ #38748
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Test 1

I created a testing branch that prevents some updates from being applied (therefore GetMissingOnyxUpdates will be triggered) and has some useful logs.

Either test in this branch or on your own. In OnyxUpdateManager do the following:

Delay the call to applyDeferredUpdates with a setTimeout
Prevent some update from being applied
Check that GetMissingOnyxUpdates is triggered
Add some more updates
Check that these updates are added to the deferredUpdates object
Check that no more calls to GetMissingOnyxUpdates are performed
Once the timeout has ended, check that both the missing and deferred updates are applied correctly.

Test 2

Create a chat report with a peer
Create a policy room between both of you

after those rooms are created, and both of you opened them at least once, comment these calls to make sure we're not reloading the data from the backend instead:

App/src/libs/actions/Report.ts

Lines 769 to 789 in a4d01a8

    
           if (isFromDeepLink) { 
        
               // eslint-disable-next-line rulesdir/no-api-side-effects-method 
        
               API.makeRequestWithSideEffects(SIDE_EFFECT_REQUEST_COMMANDS.OPEN_REPORT, parameters, {optimisticData, successData, failureData}).finally(() => { 
        
                   Onyx.set(ONYXKEYS.IS_CHECKING_PUBLIC_ROOM, false); 
        
               }); 
        
           } else { 
        
               // eslint-disable-next-line rulesdir/no-multiple-api-calls 
        
               API.write( 
        
                   WRITE_COMMANDS.OPEN_REPORT, 
        
                   parameters, 
        
                   {optimisticData, successData, failureData}, 
        
                   { 
        
                       getConflictingRequests: (persistedRequests) => 
        
                           // requests conflict only if: 
        
                           // 1. they are OpenReport commands 
        
                           // 2. they have the same reportID 
        
                           // 3. they are not creating a report - all calls to OpenReport that create a report will be unique and have a unique createdReportActionID 
        
                           persistedRequests.filter((request) => request.command === WRITE_COMMANDS.OPEN_REPORT && request.data?.reportID === reportID && !request.data?.createdReportActionID), 
        
                   }, 
        
               ); 
        
           }

Now send messages in both chat rooms, alternating between them, and fast, in a way that you can notice if anything is missing (so both start sending some kind of ordered messages, like sequential numbers)
Make sure that none of the messages were lost in those chats.

Offline tests

Not needed.

QA Steps

Verify that no errors appear in the JS console
Open a chat between two testers
Both testers should send consecutive messages at the same time (e.g. 1, 2, 3, 4)
No message should be lost between them
No more than 1 GetMissingOnyxMessages request should be executed at the same time

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Tested deferring logic on web, iOS and Android. mWeb behavior is the same as in web...

…7-@chrispader/prevent-simultaneous-calls-to-GetMissingOnyxMessages" This reverts commit 3864cdb, reversing changes made to 42ee04c.

melvin-bot · 2024-04-05T10:20:16Z

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

hungvu193 · 2024-04-05T10:48:17Z

Taking a look on test build 👀

eh2077 · 2024-04-05T10:54:14Z

@chrispader Could you kindly elaborate how this PR fixes those deploy blocker issues? Thanks!

hungvu193 · 2024-04-05T10:55:09Z

BUG: It always redirects to NotFound page after refreshing a page.

Screen.Recording.2024-04-05.at.17.54.16.mov

chrispader · 2024-04-05T10:57:59Z

@chrispader Could you kindly elaborate how this PR fixes those deploy blocker issues? Thanks!

I cannot say if the change fixes the problem, because this seems to only happen on very-high traffic accounts.

I removed this check for invalid update formats, which unpauses the SequentialQueue which might cause the problem

danieldoglas · 2024-04-05T11:02:34Z

@hungvu193 I think that's an issue unrelated to this PR, it happens on the PR testing domain

danieldoglas · 2024-04-05T11:03:37Z

@eh2077 @hungvu193 You'll need to try to simulate a situation with a lot of data going on between you. sending lots of messages on groups both of you are and etc. It's gonna be a tough one to test.

hungvu193 · 2024-04-05T11:08:16Z

@danieldoglas Can you create a slack thread to discuss about testing this PR? It would be better

chrispader · 2024-04-08T08:40:14Z

@danieldoglas Can you create a slack thread to discuss about testing this PR? It would be better

i asked about that here: https://expensify.slack.com/archives/C049HHMV9SM/p1712330961862649?thread_ts=1712264151.436019&cid=C049HHMV9SM

@danieldoglas could you check if there are (other) people that have time and can test this with their accounts?

hungvu193 · 2024-04-08T08:42:34Z

I did few tests over the weekend, I'll test again today with @eh2077

eh2077 · 2024-04-08T11:39:11Z

I tried to reproduce this DB issue #39650 but failed to dupe it. I use high traffic accounts.

eh2077 · 2024-04-08T12:08:50Z

I tried to reproduce this DB issue #39650 but failed to dupe it. I use high traffic accounts.

@chrispader I managed to reproduce #39650 using two high traffic accounts. It's not stable but I reproduced it by following steps
Preq: Account A on mobile device, Account B on Chrome Web

Send several messages from B to A
Send several messages from A to B
Observed that messages are received normally
Wait a few minutes
Send several messages from A to B
Observed that, from B, the last message is shown in LHN but is not shown in the chat

chrispader · 2024-04-09T12:49:02Z

I tried to reproduce this DB issue #39650 but failed to dupe it. I use high traffic accounts.

@chrispader I managed to reproduce #39650 using two high traffic accounts. It's not stable but I reproduced it by following steps Preq: Account A on mobile device, Account B on Chrome Web

Send several messages from B to A

Send several messages from A to B

Observed that messages are received normally

Wait a few minutes

Send several messages from A to B

Observed that, from B, the last message is shown in LHN but is not shown in the chat

you reproduced this with the current branch still?

chrispader · 2024-04-26T21:41:15Z

@hungvu193 i'm also not 100% sure if this isn't somehow caused by my changes in the testing branch by the way i intentionally drop updates and delay them.

chrispader · 2024-04-26T21:41:18Z

JFYI @danieldoglas @hungvu193 @arosiclair
I'm gonna be OOO from 28/04 until 7. or 8. of May. If we cannot resolve this issue until then, i'm gonna have to hand the PR over to one of my colleagues from Margelo.

hungvu193 · 2024-04-27T00:54:32Z

@hungvu193 i'm also not 100% sure if this isn't somehow caused by my changes in the testing branch by the way i intentionally drop updates and delay them.

Can you try these steps?

Send message from 1 to 9.
Edit messages 9 to 5.
Wait for all updates to be applied.
Add and remove few reactions
Observer the result

I saw the timeout, however I waited for few minutes and still didn't see the updated.
I'll take another test later today

chrispader · 2024-04-27T06:46:27Z

I saw the timeout, however I waited for few minutes and still didn't see the updated. I'll take another test later today

Ahh i see now what the problem is. It's not the actual implementation, but just the testing branch. I basically drop every third and fourth update, to simulate missing updates. If one or both of these (omitted) updates are at the end of all the updates (like the last emoji reaction), they will never be applied, because there is no later update that triggers the GetMissingOnyxMessages flow.

In the testing branch in applyOnyxUpdatesReliably if you set the shouldOmitUpdate flag to false, this issue should not happen anymore. Can you confirm that?

hungvu193 · 2024-04-27T09:57:36Z

In the testing branch in applyOnyxUpdatesReliably if you set the shouldOmitUpdate flag to false, this issue should not happen anymore. Can you confirm that?

~~you mean shouldRunSync to false right?~~

App/src/libs/actions/applyOnyxUpdatesReliably.ts

Line 14 in 10fc359

    
           export default function applyOnyxUpdatesReliably(updates: OnyxUpdatesFromServer, shouldRunSync = false, clientLastUpdateID = 0) {

Oh I saw it 🤦 I checked out this branch instead of testing branch.

…updates-after-revert

danieldoglas · 2024-04-28T23:49:03Z

Nice. Seems like this is almost there... @hungvu193 @eh2077 you think we're good to merge this?

hungvu193 · 2024-04-28T23:50:27Z

Nice. Seems like this is almost there... @hungvu193 @eh2077 you think we're good to merge this?

Sounds good to me 😄

chrispader · 2024-04-29T08:53:16Z

If only resetting deferredUpdatesProxy.deferredUpdates after calling method detectGapsAndSplit, the two tests are also passed.

i'm not sure i understand what you mean. what scneria would resetting deferred updates after detectGapsAnsSplit simulate?

The deferred updates should/can only be reset by the OnyxUpdateManager.

Do you mean we should protect this export, so manipulation from the outside is not possible?

eh2077 · 2024-04-29T10:12:15Z

@chrispader thanks for your comment. Sorry, please omit my comments as I overlooked and misunderstood something.

eh2077 · 2024-04-29T11:47:52Z

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

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

Screen.Recording.2024-04-25.at.17.50.04.mp4

0-test-2.mp4

MacOS: Desktop

NA

OSBotify · 2024-04-30T01:45:17Z

✋ 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-05-01T03:01:16Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.69-0 🚀

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

kbecciv · 2024-05-01T19:36:08Z

@chrispader @danieldoglas QA team is blocked to verify this PR, having the following error when trying to run the code snippet in console. Can you please verify internally?

francoisl · 2024-05-02T05:10:36Z

The QA steps shouldn't involve commenting code out, can you guys think of an alternative way to QA this internally please?

danieldoglas · 2024-05-02T10:04:34Z

@kbecciv Updated the tests

kbecciv · 2024-05-02T11:52:07Z

@danieldoglas

This PR is failing because of issue #38748 - there are multiple GetMissingOnyxMessages requests in request tab.

The issue is checked in: Web and Desktop

1714647274460.Screen_Recording_2024-05-02_at_1.46.33_in_the_afternoon.mp4

OSBotify · 2024-05-02T13:04:51Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

danieldoglas · 2024-05-02T15:18:36Z

That actually seems correct - it did 3, but one at a time, not 3 at the same time.

chrispader · 2024-05-13T10:29:54Z

@danieldoglas i didn't follow recent conversations 100%, but i think the implementation in this PR is still valid and there's no need to fix anything right now, right?

danieldoglas · 2024-05-13T13:37:28Z

Yep, this is all correct.

chrispader added 3 commits April 5, 2024 08:18

Revert "Merge pull request Expensify#39668 from Expensify/revert-3899…

068e624

…7-@chrispader/prevent-simultaneous-calls-to-GetMissingOnyxMessages" This reverts commit 3864cdb, reversing changes made to 42ee04c.

remove queue clearing and add TS type guard for OnyxUpdate

1a8528c

fix: type check

e52db00

danieldoglas added the Ready To Build label Apr 5, 2024

danieldoglas requested review from eh2077 and hungvu193 April 5, 2024 10:05

chrispader added 3 commits April 5, 2024 12:07

simplify code

2e13b36

simplify code

4fbbd9a

fix: and simplify

9eaa455

danieldoglas removed the Ready To Build label Apr 5, 2024

chrispader marked this pull request as ready for review April 5, 2024 10:20

chrispader requested a review from a team as a code owner April 5, 2024 10:20

melvin-bot bot removed the request for review from a team April 5, 2024 10:20

add comment

c134283

danieldoglas added the Ready To Build label Apr 5, 2024

rename variables

36c9ad6

This comment has been minimized.

Sign in to view

Merge branch 'main' into @chrispader/GetMissingOnyxMessages-deferred-…

f48d931

…updates-after-revert

This comment was marked as resolved.

Sign in to view

hungvu193 approved these changes Apr 29, 2024

View reviewed changes

melvin-bot bot requested a review from danieldoglas April 29, 2024 11:00

eh2077 approved these changes Apr 29, 2024

View reviewed changes

danieldoglas approved these changes Apr 30, 2024

View reviewed changes

danieldoglas merged commit cad52d9 into Expensify:main Apr 30, 2024
16 of 20 checks passed

github-actions bot mentioned this pull request May 1, 2024

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

melvin-bot bot mentioned this pull request May 2, 2024

[HOLD for payment 2024-05-09] HIGH: [API Reliability] Prevent simultaneous calls to GetMissingOnyxMessages using a deferredUpdates queue #38748

Closed

chrispader mentioned this pull request May 16, 2024

Add deferred updates queue functions to OnyxUpdateManager to manually apply updates (e.g. from push notifications) #42044

Merged

50 tasks

	if (isFromDeepLink) {
	// eslint-disable-next-line rulesdir/no-api-side-effects-method
	API.makeRequestWithSideEffects(SIDE_EFFECT_REQUEST_COMMANDS.OPEN_REPORT, parameters, {optimisticData, successData, failureData}).finally(() => {
	Onyx.set(ONYXKEYS.IS_CHECKING_PUBLIC_ROOM, false);
	});
	} else {
	// eslint-disable-next-line rulesdir/no-multiple-api-calls
	API.write(
	WRITE_COMMANDS.OPEN_REPORT,
	parameters,
	{optimisticData, successData, failureData},
	{
	getConflictingRequests: (persistedRequests) =>
	// requests conflict only if:
	// 1. they are OpenReport commands
	// 2. they have the same reportID
	// 3. they are not creating a report - all calls to OpenReport that create a report will be unique and have a unique createdReportActionID
	persistedRequests.filter((request) => request.command === WRITE_COMMANDS.OPEN_REPORT && request.data?.reportID === reportID && !request.data?.createdReportActionID),
	},
	);
	}

After revert: Defer local updates if there are missing updates and only call GetMissingOnyxMessages once #39683

After revert: Defer local updates if there are missing updates and only call GetMissingOnyxMessages once #39683

Conversation

chrispader commented Apr 5, 2024 • edited by danieldoglas Loading

Details

Fixed Issues

Tests

Test 1

Test 2

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 5, 2024

This comment has been minimized.

hungvu193 commented Apr 5, 2024 • edited Loading

eh2077 commented Apr 5, 2024

hungvu193 commented Apr 5, 2024

chrispader commented Apr 5, 2024

danieldoglas commented Apr 5, 2024

danieldoglas commented Apr 5, 2024

hungvu193 commented Apr 5, 2024

chrispader commented Apr 8, 2024

hungvu193 commented Apr 8, 2024

eh2077 commented Apr 8, 2024 • edited Loading

eh2077 commented Apr 8, 2024

chrispader commented Apr 9, 2024

chrispader commented Apr 26, 2024

chrispader commented Apr 26, 2024 • edited Loading

hungvu193 commented Apr 27, 2024 • edited Loading

chrispader commented Apr 27, 2024 • edited Loading

hungvu193 commented Apr 27, 2024 • edited Loading

danieldoglas commented Apr 28, 2024

hungvu193 commented Apr 28, 2024

This comment was marked as resolved.

chrispader commented Apr 29, 2024

eh2077 commented Apr 29, 2024

eh2077 commented Apr 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Apr 30, 2024

OSBotify commented May 1, 2024

kbecciv commented May 1, 2024

francoisl commented May 2, 2024

danieldoglas commented May 2, 2024

kbecciv commented May 2, 2024

OSBotify commented May 2, 2024

danieldoglas commented May 2, 2024

chrispader commented May 13, 2024

danieldoglas commented May 13, 2024

After revert: Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #39683

After revert: Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #39683

chrispader commented Apr 5, 2024 •

edited by danieldoglas

Loading

hungvu193 commented Apr 5, 2024 •

edited

Loading

eh2077 commented Apr 8, 2024 •

edited

Loading

chrispader commented Apr 26, 2024 •

edited

Loading

hungvu193 commented Apr 27, 2024 •

edited

Loading

chrispader commented Apr 27, 2024 •

edited

Loading

hungvu193 commented Apr 27, 2024 •

edited

Loading

eh2077 commented Apr 29, 2024 •

edited

Loading