Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #38997

chrispader · 2024-03-26T12:11:11Z

Details

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

Only Test 2 from "Tests"

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...

…tMissingOnyxMessages

chrispader · 2024-03-26T18:12:33Z

@danieldoglas could you take a look at the current implementation and just check, if this is at least somehow what you expected? just checking before i spend too much time on the actual implementation.

I expect this PR to be done tomorrow if the current approach is feasible.

danieldoglas

Added a few comments, but I think we're missing a few things:

We should only apply the deferred updates if the current applied update is smaller than their lastUpdateID. Another way to see this is that we should only apply them if they are > the tha lastUpdateID in the deferredUpdateBeforeReconnect
By applying the item above, we need to confirm that the updates that were received are also linked correctly to the deferredUpdateBeforeReconnect
I'm not sure if there are gains in persisting the deferredUpdates or not. I think maybe not?

src/libs/actions/OnyxUpdateManager.ts

chrispader · 2024-03-27T11:04:02Z

We should only apply the deferred updates if the current applied update is smaller than their lastUpdateID. Another way to see this is that we should only apply them if they are > the tha lastUpdateID in the deferredUpdateBeforeReconnect

I updated the code so that we check for "old" deferred updates, that have already been applied through GetMissingOnyxUpdates. I basically just filter them out and store the rest in pendingDeferredUpdates, since they can only be outdated, if they were included in the response from GetMissingOnyxUpdates.

By applying the item above, we need to confirm that the updates that were received are also linked correctly to the deferredUpdateBeforeReconnect

Are case (1) and (2) expected to happen subsequently? As in my other comment, i might not fully understand case (1).

I'm not sure if there are gains in persisting the deferredUpdates or not. I think maybe not?

I don't think we need to persist the deferred values, since on a reload/restart we're fetching everything again anyway, right?

Updated the code and tested it thoroughly. I'm manually skipping some updates locally to simulate XHR requests not reaching the client. The missing updates are received from GetMissingOnyxUpdates and the (filtered) deferred updates are linked and applied correctly.

@danieldoglas let me know what you think and maybe you can test this on your machine as well, so we're safe here...

melvin-bot · 2024-03-27T11:05:01Z

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

chrispader · 2024-03-27T11:19:58Z

No need for C+ on this one!

Not sure if we need a C+ on this one? @danieldoglas

#38748 (comment)

…tMissingOnyxMessages

danieldoglas · 2024-03-28T17:17:17Z

I don't think we need a C+ on this one! Removing @getusha

src/libs/actions/OnyxUpdateManager.ts

chrispader · 2024-03-29T12:30:18Z

@danieldoglas just triggered another review request. Could you give this a look, so we can maybe merge this today?

I'll try to be available in the evening, in case there are any issues.

hungvu193 · 2024-04-02T14:55:25Z

Just tested this on main, and i'm seeing these screen flashes and lags there too. So this seems unrelated to this PR.

On the left side, you can see main running on the local dev server. On the right is just new.expensify.com:

Screen.Recording.2024-04-02.at.16.31.29.mov

Confirmed it's also happening on Staging

chrispader · 2024-04-02T15:01:24Z

Ok cool. Let's me check. Also can I use your test branch now?

Yes, you can use it. But the goal of this test branch is to just receive some messages in any report (that were sent from another device+account) and then in the DevTools you will see a bunch of logs, that show, that the logic is working

src/libs/actions/OnyxUpdateManager.ts

eh2077 · 2024-04-02T15:39:57Z

src/libs/actions/OnyxUpdateManager.ts

+// In order for the deferred updates to be applied correctly in order,
+// we need to check if there are any gaps between deferred updates.
+type DetectGapAndSplitResult = {applicableUpdates: DeferredUpdatesDictionary; updatesAfterGaps: DeferredUpdatesDictionary; latestMissingUpdateID: number | undefined};
+function detectGapsAndSplit(updates: DeferredUpdatesDictionary): DetectGapAndSplitResult {


I think a few examples or test cases here will be very helpful to understand the code.

hungvu193 · 2024-04-02T16:27:05Z

Ok, I can confirm the logic worked on test branch

Screen.Recording.2024-04-02.at.22.29.40.mov

danieldoglas · 2024-04-02T16:51:11Z

@hungvu193 @eh2077 please also confirm through the network tab that we're not executing several GetMissingOnyxUpdates at the same time while you're testing this

hungvu193 · 2024-04-02T17:07:49Z

@hungvu193 @eh2077 please also confirm through the network tab that we're not executing several GetMissingOnyxUpdates at the same time while you're testing this

Yep. I can confirm it as well.

GetmissingOnyx.mov

Co-authored-by: Eric Han <117511920+eh2077@users.noreply.github.com>

…tMissingOnyxMessages

danieldoglas · 2024-04-03T06:15:07Z

@eh2077 , anything else you've noted on this PR that we might need to change?

eh2077 · 2024-04-03T08:04:38Z

@danieldoglas Sorry for the delay. I'm on it and let me look into the code and do some more tests. Will update in an hour.

eh2077 · 2024-04-03T09:34:31Z

@chrispader I tested the case described in primary GH #38748. I found that sometimes GetMissingOnyxMessages was called two times.

0-API-call-2-times.mp4

And the console log FYI

chrispader · 2024-04-03T09:56:48Z

@chrispader I tested the case described in primary GH #38748. I found that sometimes GetMissingOnyxMessages was called two times.

And the console log FYI

@eh2077 I'm not sure about your case exactly, but this is intentional. When we find a gap in the deferred updates, We will trigger a second call to GetMissingOnyxMessages, and potentially even more, until all gaps have been resolved.

This is a recursive call in https://github.com/margelo/expensify-app-fork/blob/cd48514a02629f49f39d769425e6b866a8d9a4b6/src/libs/actions/OnyxUpdateManager.ts#L150

eh2077 · 2024-04-03T09:58:59Z

@chrispader I see. So, multiple API calls are expected as long as there's no overlapping of the updateID ranges of them, right?

chrispader · 2024-04-03T10:01:58Z

@chrispader I see. So, multiple API calls are expected as long as there's no overlapping of the updateID ranges of them, right?

yes, basically. It might potentially be the case though, that the updateIDTo of the first call is the updateIDFrom of the second call, in case the first deferred update already creates a gap.

eh2077 · 2024-04-03T10:22:44Z

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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

0-API-call-2-times.mp4

MacOS: Desktop

N/A

eh2077

Looks good and tested well.

OSBotify · 2024-04-03T10:41:14Z

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

kavimuru · 2024-04-04T17:22:16Z

@danieldoglas @hungvu193 Could you explain the step 3 in Tests 2 section?

aldo-expensify · 2024-04-05T00:45:33Z

This seems to have cause this deploy blocker #39650 and this crash https://expensify.slack.com/archives/C049HHMV9SM/p1712264151436019

OSBotify · 2024-04-08T10:55:35Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

chrispader added 7 commits March 26, 2024 13:09

defer updates if missing updates are fetched

d32cd8b

simplify

e41558e

move deferred updates out of callback

931527c

simplify comments

5088441

Merge branch 'main' into @chrispader/prevent-simultaneous-calls-to-Ge…

9954e40

…tMissingOnyxMessages

Merge branch 'main' into @chrispader/prevent-simultaneous-calls-to-Ge…

a314f1f

…tMissingOnyxMessages

fix: apply deferred updates in order

9d818d3

chrispader mentioned this pull request Mar 26, 2024

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

Closed

danieldoglas reviewed Mar 26, 2024

View reviewed changes

chrispader added 2 commits March 27, 2024 11:44

simplify and improve applying deferred updates

f21ea78

check if deferred updates are older than the currently applied one

3cc017e

chrispader marked this pull request as ready for review March 27, 2024 11:04

chrispader requested a review from a team as a code owner March 27, 2024 11:04

melvin-bot bot removed the request for review from a team March 27, 2024 11:05

melvin-bot bot requested a review from getusha March 27, 2024 11:05

improve code

ce9027c

chrispader changed the title ~~[WIP] Defer local updates if missing updates are fetched via GetMissingOnyxMessages~~ Defer local updates if there are missing updates and only call GetMissingOnyxMessages once Mar 27, 2024

Merge branch 'main' into @chrispader/prevent-simultaneous-calls-to-Ge…

9889206

…tMissingOnyxMessages

chrispader requested a review from danieldoglas March 27, 2024 15:14

danieldoglas removed the request for review from getusha March 28, 2024 17:17

danieldoglas reviewed Mar 28, 2024

View reviewed changes

src/libs/actions/OnyxUpdateManager.ts Outdated Show resolved Hide resolved

fix: refetching logic

c3034e0

chrispader requested a review from danieldoglas March 29, 2024 12:29

fix: comments and logic

b9afdf3

eh2077 reviewed Apr 2, 2024

View reviewed changes

src/libs/actions/OnyxUpdateManager.ts Outdated Show resolved Hide resolved

src/libs/actions/OnyxUpdateManager.ts Show resolved Hide resolved

eh2077 reviewed Apr 2, 2024

View reviewed changes

hungvu193 approved these changes Apr 2, 2024

View reviewed changes

melvin-bot bot requested a review from danieldoglas April 2, 2024 17:13

chrispader and others added 2 commits April 2, 2024 19:43

Update OnyxUpdateManager.ts

67f322e

Co-authored-by: Eric Han <117511920+eh2077@users.noreply.github.com>

Merge branch 'main' into @chrispader/prevent-simultaneous-calls-to-Ge…

cd48514

…tMissingOnyxMessages

eh2077 approved these changes Apr 3, 2024

View reviewed changes

danieldoglas approved these changes Apr 3, 2024

View reviewed changes

danieldoglas merged commit 488664d into Expensify:main Apr 3, 2024
16 checks passed

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

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

luacmartins mentioned this pull request Apr 4, 2024

[CP Staging] Revert "Defer local updates if there are missing updates and only call GetMissingOnyxMessages once" #39668

Merged

aldo-expensify mentioned this pull request Apr 5, 2024

Chat - Second and subsequent messages not displayed in chat until chat reloaded #39650

Closed

6 tasks

chrispader mentioned this pull request Apr 5, 2024

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

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #38997

Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #38997

chrispader commented Mar 26, 2024 •

edited

Loading

chrispader commented Mar 26, 2024

danieldoglas left a comment

chrispader commented Mar 27, 2024 •

edited

Loading

melvin-bot bot commented Mar 27, 2024

chrispader commented Mar 27, 2024

danieldoglas commented Mar 28, 2024

chrispader commented Mar 29, 2024

hungvu193 commented Apr 2, 2024

chrispader commented Apr 2, 2024

eh2077 Apr 2, 2024 •

edited

Loading

hungvu193 commented Apr 2, 2024

danieldoglas commented Apr 2, 2024

hungvu193 commented Apr 2, 2024

danieldoglas commented Apr 3, 2024

eh2077 commented Apr 3, 2024

eh2077 commented Apr 3, 2024 •

edited

Loading

chrispader commented Apr 3, 2024 •

edited

Loading

eh2077 commented Apr 3, 2024

chrispader commented Apr 3, 2024

eh2077 commented Apr 3, 2024 •

edited

Loading

eh2077 left a comment

OSBotify commented Apr 3, 2024

kavimuru commented Apr 4, 2024

aldo-expensify commented Apr 5, 2024

OSBotify commented Apr 8, 2024

	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),
	},
	);
	}

Defer local updates if there are missing updates and only call GetMissingOnyxMessages once #38997

Defer local updates if there are missing updates and only call GetMissingOnyxMessages once #38997

Conversation

chrispader commented Mar 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Test 1

Test 2

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

chrispader commented Mar 26, 2024

danieldoglas left a comment

Choose a reason for hiding this comment

chrispader commented Mar 27, 2024 • edited Loading

melvin-bot bot commented Mar 27, 2024

chrispader commented Mar 27, 2024

danieldoglas commented Mar 28, 2024

chrispader commented Mar 29, 2024

hungvu193 commented Apr 2, 2024

chrispader commented Apr 2, 2024

eh2077 Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

hungvu193 commented Apr 2, 2024

danieldoglas commented Apr 2, 2024

hungvu193 commented Apr 2, 2024

danieldoglas commented Apr 3, 2024

eh2077 commented Apr 3, 2024

eh2077 commented Apr 3, 2024 • edited Loading

chrispader commented Apr 3, 2024 • edited Loading

eh2077 commented Apr 3, 2024

chrispader commented Apr 3, 2024

eh2077 commented Apr 3, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 3, 2024

kavimuru commented Apr 4, 2024

aldo-expensify commented Apr 5, 2024

OSBotify commented Apr 8, 2024

Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #38997

Defer local updates if there are missing updates and only call `GetMissingOnyxMessages` once #38997

chrispader commented Mar 26, 2024 •

edited

Loading

chrispader commented Mar 27, 2024 •

edited

Loading

eh2077 Apr 2, 2024 •

edited

Loading

eh2077 commented Apr 3, 2024 •

edited

Loading

chrispader commented Apr 3, 2024 •

edited

Loading

eh2077 commented Apr 3, 2024 •

edited

Loading