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

chrispader · 2024-05-13T10:22:00Z

Details

This PR adds three new functions to the OnyxUpdateManager which let you manage the updates in the deferred updates queue. It particularly a clean interface to access and control deferred updates.

The DeferredOnyxUpdates module mainly includes the following functions:

enqueue() let's you add updates to the queue. By default, this will automatically trigger processing these items with validateAndApplyDeferredUpdates
process() waits for the current queryPromise (when there are missing onyx updates currently fetched from the server) and then triggers validateAndApplyDeferredUpdates
- enqueueAndProcess() combines the upper two functions by first enqueuing and then immediately processing the updates.
clear manually clears the deferred updates queue. By default, this unpauses the SequentialQueue as well.

Fixed Issues

$ #40227
PROPOSAL:

Tests

Verify that no errors appear in the JS console

To ensure the functionality from #39683 is preserverd:

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

Same as in Tests.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-13T10:22:31Z

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

arosiclair

Looks pretty good on first glance, but could we rename the deferredUpdatesProxy lib to just DeferredUpdates and then move these enqueue, process and clear functions there? That way we can have a pretty clean API (eg: DeferredUpdates.enqueue())

chrispader · 2024-05-13T16:11:11Z

Looks pretty good on first glance, but could we rename the deferredUpdatesProxy lib to just DeferredUpdates and then move these enqueue, process and clear functions there? That way we can have a pretty clean API (eg: DeferredUpdates.enqueue())

That was my first idea as well, but we also want to be able to trigger validateAndApplyDeferredUpdates which requires accesing the queryPromise.

I think it's more robust if the developer just interacts with the OnyxUpdateManager and doesn't have to think about deferred updates too much. Do you agree?

I can still rename deferredUpdatesProxy to DeferredUpdates, that fine.

chrispader · 2024-05-13T16:12:08Z

Still, i can also extract the queryPromise out of the OnyxUpdateManager (also with a proxy) and move the new functions to DeferredUpdates.

…tions

chrispader · 2024-05-14T10:58:34Z

Looks pretty good on first glance, but could we rename the deferredUpdatesProxy lib to just DeferredUpdates and then move these enqueue, process and clear functions there? That way we can have a pretty clean API (eg: DeferredUpdates.enqueue())

@arosiclair nevermind, i just changed the structure as you suggested. We now have a DeferredUpdates module that exports both the deferredUpdates itself as well as the new functions

…tions

arosiclair

Appreciate the changes! Just looking for a bit better encapsulation on the DeferredUpdates lib

src/libs/actions/OnyxUpdateManager/utils/DeferredUpdates.ts

src/libs/actions/OnyxUpdateManager/index.ts

src/libs/actions/OnyxUpdateManager/utils/index.ts

src/libs/actions/OnyxUpdateManager/utils/DeferredUpdates.ts

arosiclair · 2024-05-14T19:56:34Z

src/libs/actions/OnyxUpdateManager/utils/GetMissingOnyxUpdatesPromise.ts

+
+const GetMissingOnyxUpdatesPromiseValue = {GetMissingOnyxUpdatesPromise: undefined as Promise<Response | Response[] | void> | undefined};
+
+export default createProxyForObject(GetMissingOnyxUpdatesPromiseValue);


As you might guess I'm not a big fan of this proxy object pattern 😄. These feel more or less like global variables and are prone to error in the same way since their values can be changed anywhere, at anytime and in any way.

It feels like we're pretty much creating a lock with this object so it would be nice if we could abstract it like one. However, I'm not sure exactly how it would look.

Cleaning this up is NAB but if you know an easy way to write it I'm curious.

chrispader · 2024-05-14T21:23:12Z

@arosiclair i adapted the implementation, but it's still WIP. I'll update you tmrw!

…tions

chrispader · 2024-05-15T10:11:36Z

@arosiclair this is now done! I moved and adapted the the deferred updates queue to DeferredOnyxUpdates.ts (i think this name is more clear). There's no direct access to the underlying deferredUpdates object anymore.

This module includes your requested functions as well as DeferredOnxyUpdates.enqueueAndProcess(), which will process the queue after pushing new updates immediately. enqueue() will just push them.

arosiclair

Looking good. Can you add some test steps? Also will the unit tests we added before cover these changes?

src/libs/actions/OnyxUpdateManager/utils/DeferredOnyxUpdates.ts

Co-authored-by: Andrew Rosiclair <arosiclair@gmail.com>

chrispader · 2024-05-16T15:07:36Z

Looking good. Can you add some test steps? Also will the unit tests we added before cover these changes?

Yes, the unit and action tests actually already catched some issues while implementing this and they cover (all of) the functionality that are affected by these changes

chrispader · 2024-05-16T15:11:45Z

@arosiclair updated the PR :)

arosiclair

Great work!

arosiclair · 2024-05-16T15:38:05Z

@allroundexperts can you review and do the checklist?

allroundexperts · 2024-05-16T15:43:28Z

Yep. I'll be done in 30-45 minutes.

allroundexperts · 2024-05-16T15:55:42Z

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

screen-recording-2024-05-16-at-111913-pm_nehDWa0J.mp4

screen-recording-2024-05-16-at-111647-pm_ei56v13T.mp4

MacOS: Desktop

Screen.Recording.2024-05-16.at.11.40.45.PM.mov

allroundexperts · 2024-05-16T16:07:36Z

@arosiclair I think this can not really be tested on mobile. Is that correct?

arosiclair · 2024-05-16T17:13:03Z

@arosiclair I think this can not really be tested on mobile. Is that correct?

Yeah @chrispader's testing steps only seem do-able on web and desktop so I think we can just test those.

allroundexperts

This is testing fine. Messages are not getting lost but I was not able to confirm there order. Sometimes, they appeared out of order. Not sure if that is expected.

arosiclair · 2024-05-16T21:26:36Z

Merge freeze is on currently. I'll merge when that's done

OSBotify · 2024-05-23T18:30:07Z

✋ 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-27T14:25:17Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.76-0 🚀

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

OSBotify · 2024-05-29T09:17:55Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.76-7 🚀

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

add encapsulated functionality to OnyxUpdateManager

23b0714

chrispader requested a review from a team as a code owner May 13, 2024 10:22

melvin-bot bot requested review from nkuoch and removed request for a team May 13, 2024 10:22

chrispader mentioned this pull request May 13, 2024

[HOLD for payment 2024-06-05] [$250] CRITICAL: Tapping on Push Notification fails to retrieve Onyx updates #40227

Closed

6 tasks

arosiclair reviewed May 13, 2024

View reviewed changes

Christoph Pader added 2 commits May 14, 2024 12:40

Merge branch 'main' into @chrispader/add-deferred-updates--queue-func…

ddc09c1

…tions

restructure deferred updates functions

b3de363

Christoph Pader added 7 commits May 14, 2024 13:04

fix: wrong imports

c385463

rename file

91032c8

rename file

4a3b39a

fix lint

e11b521

add comment

d159c01

Merge branch 'main' into @chrispader/add-deferred-updates--queue-func…

f907326

…tions

fix: lint errors

c91b5c0

arosiclair requested changes May 14, 2024

View reviewed changes

Christoph Pader added 5 commits May 14, 2024 22:39

rename functions

c57a5e9

restructure

340125e

rename

0455e0d

rename

6f7436a

change functions

da8b8ba

Christoph Pader added 4 commits May 15, 2024 11:39

Merge branch 'main' into @chrispader/add-deferred-updates--queue-func…

a52e2ca

…tions

rename file

e427034

rename functions

4379a0a

invert condition

9df344c

Christoph Pader added 2 commits May 15, 2024 12:07

fix: simplify function signatures

17c5d0b

use non-default exports

15600b0

add comment

ccedd1c

arosiclair requested changes May 15, 2024

View reviewed changes

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

Update DeferredOnyxUpdates.ts

342873e

Co-authored-by: Andrew Rosiclair <arosiclair@gmail.com>

chrispader requested a review from arosiclair May 16, 2024 15:11

arosiclair approved these changes May 16, 2024

View reviewed changes

arosiclair requested a review from allroundexperts May 16, 2024 15:34

allroundexperts approved these changes May 16, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair May 16, 2024 18:59

arosiclair approved these changes May 20, 2024

View reviewed changes

chrispader mentioned this pull request May 23, 2024

Fix: Push notification onyx updates not applied when notification is selected #42510

Merged

48 tasks

arosiclair approved these changes May 23, 2024

View reviewed changes

arosiclair merged commit 791058a into Expensify:main May 23, 2024

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

Deploy Checklist: New Expensify 2024-05-27 #42636

Closed

69 tasks

kosmydel mentioned this pull request May 28, 2024

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

Closed

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


		const GetMissingOnyxUpdatesPromiseValue = {GetMissingOnyxUpdatesPromise: undefined as Promise<Response \| Response[] \| void> \| undefined};

		export default createProxyForObject(GetMissingOnyxUpdatesPromiseValue);

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

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

Uh oh!

Conversation

chrispader commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 13, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

chrispader commented May 13, 2024

Uh oh!

chrispader commented May 13, 2024

Uh oh!

chrispader commented May 14, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arosiclair May 14, 2024

Choose a reason for hiding this comment

Uh oh!

chrispader commented May 14, 2024

Uh oh!

chrispader commented May 15, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chrispader commented May 16, 2024

Uh oh!

chrispader commented May 16, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

arosiclair commented May 16, 2024

Uh oh!

allroundexperts commented May 16, 2024

Uh oh!

allroundexperts commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts commented May 16, 2024

Uh oh!

arosiclair commented May 16, 2024

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

arosiclair commented May 16, 2024

Uh oh!

OSBotify commented May 23, 2024

Uh oh!

OSBotify commented May 27, 2024

Uh oh!

OSBotify commented May 29, 2024

Uh oh!

Reviewers

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

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

chrispader commented May 13, 2024 •

edited

Loading

allroundexperts commented May 16, 2024 •

edited

Loading