Fix: `OnyxUpdateManager` ends up in a recursive endless loop, when previously applied Onyx updates are not chained (caused crashes on web) by chrispader · Pull Request #47429 · Expensify/App

chrispader · 2024-08-14T14:51:52Z

Details

This PR fixes a problem where the OnyxUpdateManager would end up in a recursive loop and therefore cause browser tabs to crash, because the recursive calls would build up the Stack and therefore memory. When memory consumption is to big, the browser tab will crash.

This problem was caused, because some Onyx updates from the backend "span over" the last update that was applied to the client. What i mean by that is that we keep track of the lastUpdateID of the last update, that was applied to the client in ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT. When a new (deferred) update has a previousUpdateID that is lower than lastUpdateIDAppliedToClient, this would cause the validation and application of deferred updates to end up in a loop, because we would always find a gap in the deferred updates.

Example:

The current lastUpdateIDAppliedToClient is 10. Usually, the next (expected) update would have lastUpdateID of 11 and previousUpdateID of 10.

We didn't yet handle the case properly, when next update (for some reason) has lastUpdateID 11 and previousUpdateID of 9 (or lower). We can't take 9 as the last update to fetch for missing updates, but instead have to jump out of the recursive validation process.

Fixed Issues

$ #44744
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Open NewDot in a Chrome tab with DevTools
Open OldDot in a different tab with DevTools and Network tab open
Create a report
Search for the CreateReport API call in the network log and copy it as node.js code
Use this script to create multiple new reports:

const NUM_OF_REPORTS_PER_BATCH = 30;
const NUM_OF_REPORT_BATCHES = 100;
let reportCounter = 0;
let batchCounter = 0;

function fetchReport() {
  Promise.all(
    Array(NUM_OF_REPORTS_PER_BATCH)
      .fill(0)
      .map(() => {
        return /* PASTE FETCH CODE HERE*/.then((response) => {
          if (response.status !== 200) {
            return;
          }
          reportCounter++;
          console.log(`Report ${reportCounter + 1} created!`);

          return Promise.resolve(response);
        });
      })
  ).then(() => {
    batchCounter++;
    if (batchCounter >= NUM_OF_REPORT_BATCHES) {
      return;
    }
    fetchReport();
  });
}

fetchReport();

Look at the DevTools in NewDot
Make sure that these two logs are not occurring repeatedly/recursively: (with different update IDs)

[info] [DeferredUpdates] Processing deferred updates - {"lastUpdateIDFromClient":1162701182,"previousParams":{"newLastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064}} 
[info] [DeferredUpdates] Gap detected in deferred updates - {"lastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064}

Wait for ˜100-200 reports to be created
Make sure RAM usage of the chrome tab is not going up and the tab doesn't crash

Offline tests

None needed.

QA Steps

Verify that no errors appear in the JS console

Make sure the chrome tab doesn't use too much RAM and doesn't crash when multiple reports are created.

For testing, follow same procedure 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-08-14T14:51:58Z

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

hannojg

LGTM 👍!

fedirjh · 2024-08-15T14:03:44Z

@chrispader Is this ready? The commits aren't signed.

chrispader · 2024-08-16T22:18:05Z

yes this is ready. i'm back in office on monday, i can finalize the checklist and fix the unsigned commits then

chrispader · 2024-08-16T22:19:33Z

feel free to leave a code review already

chrispader · 2024-08-19T07:57:25Z

@fedirjh i just fixed commit signatures and updated the issue description. This is officially ready for review! 🚀

fedirjh · 2024-08-19T11:56:47Z

12. Make sure that these two logs are not occurring repeatedly/recursively: (with different update IDs)
[info] [DeferredUpdates] Processing deferred updates - {"lastUpdateIDFromClient":1162701182,"previousParams":{"newLastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064}} 
[info] [DeferredUpdates] Gap detected in deferred updates - {"lastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064} 
Wait for ˜100-200 reports to be created

@chrispader In this step, These two logs are occurring repeatedly with different update IDs, is that expected ?

16. Make sure RAM usage of the chrome tab is not going up and the tab doesn't crash

I confirmed that RAM usage is stable and there was no crash issue 🚀

chrispader · 2024-08-19T12:05:39Z

Make sure that these two logs are not occurring repeatedly/recursively: (with different update IDs)
[info] [DeferredUpdates] Processing deferred updates - {"lastUpdateIDFromClient":1162701182,"previousParams":{"newLastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064}} 
[info] [DeferredUpdates] Gap detected in deferred updates - {"lastUpdateIDFromClient":1162701182,"latestMissingUpdateID":1162699064} 
@chrispader In this step, These two logs are occurring repeatedly with different update IDs, is that expected ?

Yes, this looks fine 👍 As long as it's not the same logs with the same update IDs over and over again, this is expected.

chrispader · 2024-08-19T12:06:00Z

Make sure RAM usage of the chrome tab is not going up and the tab doesn't crash

I confirmed that RAM usage is stable and there was no crash issue 🚀

Perfect! 🚀

fedirjh · 2024-08-19T13:10:05Z

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

N/A

iOS: Native

iOS: mWeb Safari

CleanShot.2024-08-19.at.14.20.24.mp4

MacOS: Chrome / Safari

https://share.cleanshot.com/t5zGqbHY

CleanShot.2024-08-19.at.12.44.27-converted.mp4

MacOS: Desktop

CleanShot.2024-08-19.at.13.36.37.mp4

fedirjh

LGTM and tests well.

marcaaron · 2024-08-19T17:31:43Z

@arosiclair added you for an extra set of eyes as I think you have some familiarity with this code from working on this PR.

marcaaron

Looks good as far as I understand this part of the code 😄 I left some ideas for the comments.

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

danieldoglas

changes make sense to me based on the example, please address Marc's comments.

arosiclair · 2024-08-19T19:50:05Z

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

        } else {
+            // If the previousUpdateID of the update after the gap is older than the lastUpdateIDFromClient,
+            // we don't want to detect a missing update, since this would cause a recursion loop in "validateAndApplyDeferredUpdates".
+            if (previousUpdateID <= lastUpdateIDFromClient) {


Can we just raise this condition up next to the other if (lastUpdateID <= lastUpdateIDFromClient) check? I think it's less confusing to follow there

This shouldn't break the upper if block, because there might be updates, that have an "outdated" previous update, but are still valid to be applied.

I used the chance to improve the code a bit and further improve the comments, so this might be more clear now.

chrispader · 2024-08-19T20:09:46Z

The last commit adds the following changes:

further improve and extend comments, improve naming of variables and remove inconsistencies
Move the call to DeferredOnyxUpdates.getUpdates({minUpdateID: lastUpdateIDFromClient}) to detectGapsAndSplit: This allows us to remove the extra filtering of outdated (previous) updates, because we move all filtering into detectGapsAndSplit

arosiclair

LGTM though the logic is still quite confusing at this point 😅. Maybe we can revisit this at another time though I'm not sure it can actually be simplified.

danieldoglas

LGTM. I agree we should try to document this with some kind of diagram to make it easier to understand.

chrispader · 2024-08-20T14:16:26Z

I agree too, i don't think we can further simplify the code without too much effort. A diagram would really help understanding the logic of the whole OnyxUpdateManager flow.

marcaaron · 2024-08-20T18:50:37Z

Thanks for the changes @chrispader! Merging this to not be a blocker, but also share concerns about the complexity. Not necessarily a bad thing as long as the code works - but maybe something we can address/improve in the future.

OSBotify · 2024-08-20T19:07:44Z

✋ 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-08-20T22:58:49Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.23-0 🚀

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

mvtglobally · 2024-08-21T16:14:04Z

Facing issue with this PR
Is it QA-ble in Staging?

trim.19463C12-9C29-4401-9110-C728906AE5D7.MOV

chrispader · 2024-08-22T10:37:45Z

Facing issue with this PR Is it QA-ble in Staging?

This is already on staging yes. What is it that you're trying to investigate exactly? @mvtglobally

I see two problems in the video you shared:

The CreateReport API call was unsuccessful (403)
You have a syntax error in the script you're trying to run.

chrispader · 2024-08-22T16:18:53Z

Just QAd and tested this on staging and it seems the OnyxUpdateManager works smoothly.

No crashes, freezes or recursions/loops detected, when creating 1000+ reports in a short time.

Here's a screen recording of what's going on:

Screen.Recording.2024-08-22.at.18.15.34.mov

OSBotify · 2024-08-22T17:12:12Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.23-0 🚀

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

chrispader requested a review from a team as a code owner August 14, 2024 14:51

melvin-bot bot requested review from fedirjh and removed request for a team August 14, 2024 14:51

chrispader mentioned this pull request Aug 14, 2024

[HOLD for payment 2024-08-29] [HOLD #465760] [$250] Chrome tab crashes when exporting large number of reports #44744

Closed

6 tasks

hannojg approved these changes Aug 14, 2024

View reviewed changes

chrispader force-pushed the @chrispader/chrome-tab-crashes-when-exporting-large-number-of-exports branch from b5ad6e6 to 46bdcd0 Compare August 19, 2024 07:34

Christoph Pader added 2 commits August 19, 2024 09:38

fix: typo

a94c759

fix: chrome crashes

13b1608

chrispader force-pushed the @chrispader/chrome-tab-crashes-when-exporting-large-number-of-exports branch from 46bdcd0 to 13b1608 Compare August 19, 2024 07:42

test: add new test for OnyxUpdateManager edge case

c3f85a3

fedirjh approved these changes Aug 19, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron August 19, 2024 14:10

marcaaron requested a review from arosiclair August 19, 2024 17:28

marcaaron requested changes Aug 19, 2024

View reviewed changes

danieldoglas reviewed Aug 19, 2024

View reviewed changes

arosiclair reviewed Aug 19, 2024

View reviewed changes

improve splitting logic and comments

9e4f20f

chrispader requested a review from marcaaron August 19, 2024 20:10

chrispader requested review from arosiclair and danieldoglas August 19, 2024 20:10

Christoph Pader added 2 commits August 19, 2024 22:11

rename new test

911a1dc

fix: lint error

4ce7ef5

arosiclair approved these changes Aug 20, 2024

View reviewed changes

danieldoglas approved these changes Aug 20, 2024

View reviewed changes

marcaaron approved these changes Aug 20, 2024

View reviewed changes

marcaaron merged commit ef5310c into Expensify:main Aug 20, 2024

marcaaron assigned chrispader Aug 20, 2024

github-actions bot mentioned this pull request Aug 20, 2024

Deploy Checklist: New Expensify 2024-08-20 #47760

Closed

38 tasks

chrispader mentioned this pull request Nov 26, 2024

[WIP] docs: Add documentation for OnyxUpdateManager and deferred updates logic #53160

Draft

50 tasks

Conversation

chrispader commented Aug 14, 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 Aug 14, 2024

Uh oh!

hannojg left a comment

Choose a reason for hiding this comment

Uh oh!

fedirjh commented Aug 15, 2024

Uh oh!

chrispader commented Aug 16, 2024

Uh oh!

chrispader commented Aug 16, 2024

Uh oh!

chrispader commented Aug 19, 2024

Uh oh!

fedirjh commented Aug 19, 2024

Uh oh!

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

Uh oh!

Uh oh!

chrispader commented Aug 19, 2024

Uh oh!

fedirjh commented Aug 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Aug 19, 2024

Uh oh!

marcaaron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

danieldoglas left a comment

Choose a reason for hiding this comment

Uh oh!

arosiclair Aug 19, 2024

Choose a reason for hiding this comment

Uh oh!

chrispader Aug 19, 2024

Choose a reason for hiding this comment

Uh oh!

chrispader commented Aug 19, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

danieldoglas left a comment

Choose a reason for hiding this comment

Uh oh!

chrispader commented Aug 20, 2024

Uh oh!

marcaaron commented Aug 20, 2024

Uh oh!

OSBotify commented Aug 20, 2024

Uh oh!

OSBotify commented Aug 20, 2024

Uh oh!

mvtglobally commented Aug 21, 2024

Uh oh!

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

Uh oh!

Uh oh!

chrispader commented Aug 22, 2024

Uh oh!

chrispader commented Aug 14, 2024 •

edited

Loading

chrispader commented Aug 19, 2024 •

edited

Loading

fedirjh commented Aug 19, 2024 •

edited

Loading

chrispader commented Aug 22, 2024 •

edited

Loading