Unpausing the queue when we receive Pusher updates while we're still loading the App by danieldoglas · Pull Request #40169 · Expensify/App

danieldoglas · 2024-04-12T09:30:30Z

Details

#39979 introduced a situation where the queue is never unpaused if you're logging in for the first time.

Fixed Issues

Related to #39380

Tests

Make sure to start BWM with ./script/bwm.sh
Edit api.php in Web-E to add sleep(10); to the OpenApp command
Sign into NewDot with a brand new account
Wait a few seconds and verify the app loads completely with stuff in the LHN and the Concierge chat loading

Verify that no errors appear in the JS console

Offline tests

None - it's required to be online to sign in

QA Steps

Sign into NewDot with a brand new account on a public domain (like gmail.com)
Wait a few seconds and verify the app loads completely with stuff in the LHN and the Concierge chat loading

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-12T09:30:58Z

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

tgolen · 2024-04-12T14:47:28Z

src/libs/actions/OnyxUpdateManager.ts

                if (isLoadingApp) {
                    console.debug(`[OnyxUpdateManager] Ignoring Onyx updates while OpenApp hans't finished yet.`);
                }
+                SequentialQueue.unpause();


Please add a comment to explain why this needs to be here. Also, can you update the comment on line 44 above so that it also explains why updates shouldn't be processed in that situation?

tgolen · 2024-04-12T15:21:22Z

src/libs/actions/OnyxUpdateManager.ts

-            // When the OpenApp command hasn't finished yet, we should not process any updates.
+            // When value is set to null (which we do once we finish processing this method), we can just return early.
+            // Alternatively, if isLoadingApp is positive, that means that OpenApp command hasn't finished yet, so we
+            // should not process any updates that are being set.


This still doesn't quite make sense. I'll ask a couple of questions maybe and then that will help you craft a comment that answers the questions.

Why should updates not be processed while OpenApp is pending? (Answer, I think: The base state of the app should be created before the first onyx updates are applied to it, or else there is a race condition where the first onyx updates get applied before the app is in its initial state and the first onyx updates are overwritten.)

Agree, useful comments say why we do things, saying what we do is kind of implied by the code (but it's fine to explain it in the comment too)

tgolen · 2024-04-12T15:23:09Z

src/libs/actions/OnyxUpdateManager.ts

+            // should not process any updates that are being set.
            if (!value || isLoadingApp) {
                if (isLoadingApp) {
+                    // Some of the places that set ONYX_UPDATES_FROM_SERVER also stop the sequential queue. If we reached


It is weird to see isLoadingApp in both if statements here. I think it would make the code more readable to turn this into two separate early returns. Then the comments might make more sense too.

There are only three places in the code which set ONYX_UPDATES_FROM_SERVER.

Two of them call SequentialQueue.unpause(); right after which is probably fine and good

This is the only one that doesn't... but it is also not pausing the queue anywhere close to it, so it doesn't appear like your comment is accurate.

Maybe a better solution is to put the SequentialQueue.unpause(); right after this just like the other occurrences? It would make more sense to put it there but I am not sure if it achieves the same result.

tgolen · 2024-04-12T15:46:17Z

src/libs/actions/OnyxUpdates.ts

 */
 function saveUpdateInformation(updateParams: OnyxUpdatesFromServer) {
+    // Pause the Sequential queue so we don't do any other requests while we're fetching missing onyxUpdates
+    SequentialQueue.unpause();


The comment says to pause the queue, but this is unpausing the queue 😓

Wrong comment, should be written unpause.

tgolen · 2024-04-12T15:47:40Z

src/libs/actions/OnyxUpdateManager.ts

+            // we don't have base state of the app (reports, policies, etc) setup. If we apply this update,
+            // we'll only have them overriten by the openApp response. So let's skip it and return.
+            if (isLoadingApp) {
+                // When ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT is set, we pause the queue. Let's unpause


Hm, I still can't see in the code where the queue is being paused where this is set.

iwiznia · 2024-04-12T15:57:47Z

src/libs/actions/OnyxUpdateManager.ts

+            }
+            // If isLoadingApp is positive it means that OpenApp command hasn't finished yet, and in that case
+            // we don't have base state of the app (reports, policies, etc) setup. If we apply this update,
+            // we'll only have them overriten by the openApp response. So let's skip it and return.


That assumes that the data is coming in OpenApp, but it might not.

iwiznia

Tested this and it works https://expensify.slack.com/archives/C06SCNUBB28/p1712941438845709?thread_ts=1712914147.449299&cid=C06SCNUBB28

You can't be a reviewer because you pushed

tgolen · 2024-04-12T17:20:28Z

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 NOTE: I was unable to test this due to a broken emulator
- 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

MacOS: Desktop

OSBotify · 2024-04-12T18:48:55Z

✋ 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-18T05:00:05Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T15:01:04Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

unpausing the queue

192aa7f

danieldoglas self-assigned this Apr 12, 2024

danieldoglas requested a review from a team as a code owner April 12, 2024 09:30

melvin-bot bot requested review from jasperhuangg and removed request for a team April 12, 2024 09:30

tgolen requested changes Apr 12, 2024

View reviewed changes

danieldoglas added 2 commits April 12, 2024 17:10

adding more comments

16e6a3f

prettier

15a1fcd

danieldoglas requested a review from tgolen April 12, 2024 15:18

tgolen requested changes Apr 12, 2024

View reviewed changes

danieldoglas added 3 commits April 12, 2024 17:40

making comments better

f9f9a09

moving the place where we pause the queue

8a63405

removing unecessary pause inside callback

7b48876

tgolen previously requested changes Apr 12, 2024

View reviewed changes

iwiznia reviewed Apr 12, 2024

View reviewed changes

Correct the comments

1f3829c

iwiznia approved these changes Apr 12, 2024

View reviewed changes

tgolen merged commit 5116f83 into main Apr 12, 2024

tgolen deleted the dsilva_unpauseQueueIfAPusherUpdateWasReceivedWhileLoadingOpenApp branch April 12, 2024 18:41

danieldoglas restored the dsilva_unpauseQueueIfAPusherUpdateWasReceivedWhileLoadingOpenApp branch April 12, 2024 19:15

danieldoglas deleted the dsilva_unpauseQueueIfAPusherUpdateWasReceivedWhileLoadingOpenApp branch April 12, 2024 19:15

danieldoglas mentioned this pull request Apr 12, 2024

Revert "Unpausing the queue when we receive Pusher updates while we're still loading the App" #40183

Merged

50 tasks

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

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

hayata-suenaga mentioned this pull request Apr 18, 2024

[HOLD for payment 2024-04-25] [$500] Chats are not loading in the LHN with Most Recent mode #39380

Closed

6 tasks

Conversation

danieldoglas commented Apr 12, 2024 • edited by tgolen 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 Apr 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danieldoglas Apr 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iwiznia left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen commented Apr 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Apr 12, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

danieldoglas commented Apr 12, 2024 •

edited by tgolen

Loading

danieldoglas Apr 12, 2024 •

edited

Loading

tgolen commented Apr 12, 2024 •

edited

Loading