Allow infinite dependent keys when using withOnyx #385

tgolen · 2023-10-04T19:54:03Z

This is a redo of #355 which had to be reverted due to performance issues.

Details

There were virtually no differences between this change and the previous change. This is what I did to try and ensure it doesn't leed to another performance issue:

Test it in App with report switching (this is what we noticed was bricking the application before). With this change, I noticed no difference in the time it takes to switch chats:

Related Issues

Related to Expensify/App#28824

Automated Tests

Covered by unit tests

Linked PRs

Expensify/App#28866

tgolen · 2023-10-04T19:55:20Z

lib/withOnyx.js

-                    const key = Str.result(mapping.key, this.props);
-                    const connectionID = this.activeConnectionIDs[key];
-                    Onyx.disconnect(connectionID, key);
+                    const key = Str.result(mapping.key, {...this.props, ...getOnyxDataFromState(this.state, mapOnyxToState)});


This is one change that is different than the original PR. I realized that the unmount() was still trying to use the old method for getting the key name. This would probably lead to somewhat of a memory leak because it could cause Onyx to keep a bunch of connections that are never disconnected from when components unmount.

Does removing this change introduce the same problem as previously?

I can give it a try. That's a good hunch

No, it doesn't appear to. I think the changes for batched updates was probably the biggest help for preventing the performance problem we saw last time.

Hm... That's making me nervous.

I just feel like this might cause more issues down the road.

Are you referring to the change in onUnmount() specifically, or this PR in general?

This PR in general.

To dig into this further, I tried the following things:

Reverted Onyx to the commit where the original PR was reverted. Then I copied these withOnyx changes to the code and tried it out. Result: I was not able to duplicate the original performance problem.

Reverted Onyx to the commit of the original PR being merged, and tried it out in the app. Result: I experienced the following fatal error (caused by the initialValue change). After fixing only that fatal error I was still not able to reproduce the original performance problem, though I did see that the report switching was taking about 2-3x longer.

I'm not sure if this fatal error was what we experienced when the original PR was deployed. We definitely witnessed the app hanging and no one could report any JS console errors or record performance profiles, but that was about it.

Conclusion: I am feeling pretty good about the changes in this PR in general. The worst that can happen is we have to do another quick revert, which would stink, but it's also not the end of the world.

One thing I did not try was using the original commit from Onyx and a commit from App on the same day... I can do that if you would like.

Sounds good to me. I'll continue my testing.

tgolen · 2023-10-04T19:56:57Z

lib/withOnyx.js

+                if (statePropertyName !== 'initialValue' && mapOnyxToState[statePropertyName]) {
+                    // eslint-disable-next-line no-param-reassign
+                    mapOnyxToState[statePropertyName].previousKey = key;
+                }


This is another small change from the previous PR. When initialValue was integrated, it lead to a situation where mapOnyxToState.initialValue: false, which caused mapOnyxToState[statePropertyName].previousKey to throw an error (because you cannot set .previousKey on the value false).

tgolen · 2023-10-05T15:13:25Z

I tested this on a large account (1000 reports each with 1000 comments) and the performance was still very good on switching chats:

allroundexperts · 2023-10-05T15:14:32Z

Thanks @tgolen. I'll finish my review today as well!

allroundexperts · 2023-10-05T16:04:41Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

Screen.Recording.2023-10-10.at.2.54.57.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-10.at.3.00.10.AM.mov

Mobile Web - Safari

Screen.Recording.2023-10-10.at.2.59.26.AM.mov

Desktop

Screen.Recording.2023-10-10.at.2.57.27.AM.mov

iOS

Screen.Recording.2023-10-10.at.2.58.26.AM.mov

Android

Screen.Recording.2023-10-10.at.3.00.48.AM.mov

allroundexperts · 2023-10-05T22:35:15Z

@tgolen Have a look at the total JS heap size. With the updated code, its going over 700MB.

Without this PR
https://github.com/Expensify/react-native-onyx/assets/30054992/68731219-358b-4810-ba79-81a0aeae138e

After this PR
https://github.com/Expensify/react-native-onyx/assets/30054992/bdae4f12-73e6-4b0f-b19a-b6061745e14c

tgolen · 2023-10-06T14:39:02Z

@allroundexperts I have done some memory testing and tried to be very methodical about it so that it is properly comparing apples to apples. My testing procedure is:

Have 10 chats each with exactly 1000 comments
Visit chat 1
Refresh the page and wait for the chat and all comments to load
Select each of the other 9 chats, and wait for the comments to load on each one before moving to the next
After the final chat has fully loaded, record a memory heap snapshot

You can see a video of it here

2023-10-06_08-20-47.mp4

I repeated this test two times, in three different code configurations (for a total of 6 results), to get a nice sampling. The code configurations I used were:

App on main, Onyx on main
App on main, Onyx on tgolen-dependent-keys2
App on experimental branch, Onyx on tgolen-dependent-keys2 - For the experimental branch on App, I removed all of the duplicate withOnyx code including the one that would impact this test this most which is in OptionRowLHNData.js. This is used for each row in the LHN and combines three separate withOnyx into a single one.

Results

Conclusion

There is no significant memory usage increase with this change.

tgolen · 2023-10-09T15:23:42Z

Bump @allroundexperts and @MonilBhavsar for reviews please. This has been lingering for a while with no requested changes.

allroundexperts · 2023-10-09T16:48:48Z

On it today @tgolen!

MonilBhavsar

Sorry, was waiting for C+ review. Looks good to me overall!

tests/unit/withOnyxTest.js

allroundexperts

Testing well!

MonilBhavsar

Thanks!

tgolen added 3 commits October 4, 2023 12:25

Re-implement dependent keys

64674d6

Implement new tests

822a982

Ignore vscode files

35be3c5

tgolen requested a review from allroundexperts October 4, 2023 19:54

tgolen requested a review from a team as a code owner October 4, 2023 19:54

tgolen self-assigned this Oct 4, 2023

melvin-bot bot requested review from MonilBhavsar and removed request for a team October 4, 2023 19:54

tgolen commented Oct 4, 2023

View reviewed changes

tgolen mentioned this pull request Oct 4, 2023

Remove duplicate withOnyx calls Expensify/App#28866

Merged

61 tasks

tgolen mentioned this pull request Oct 5, 2023

Refactor how data is loaded into the edit request page Expensify/App#28645

Merged

59 tasks

tgolen mentioned this pull request Oct 9, 2023

Allow infinite dependent keys when using withOnyx #355

Merged

MonilBhavsar previously approved these changes Oct 9, 2023

View reviewed changes

tests/unit/withOnyxTest.js Outdated Show resolved Hide resolved

tgolen dismissed MonilBhavsar’s stale review via e10755b October 9, 2023 21:38

Improve comment accuracy

e10755b

allroundexperts approved these changes Oct 9, 2023

View reviewed changes

MonilBhavsar approved these changes Oct 10, 2023

View reviewed changes

MonilBhavsar merged commit 7d8b181 into main Oct 10, 2023

ospfranco mentioned this pull request Oct 10, 2023

[NoQA] Bump onyx - Fix out of order updates Expensify/App#29169

Merged

59 tasks

tgolen deleted the tgolen-dependent-keys2 branch October 10, 2023 13:29

burczu mentioned this pull request Oct 20, 2023

[HOLD for payment 2023-11-17] [$250] Clean the usage of double onyx call on profile page Expensify/App#29165

Closed

hungvu193 mentioned this pull request Oct 25, 2023

[PAID] [$500] Web - Signing show empty content when pressing go back from another tab. Expensify/App#30288

Closed

6 tasks

pradeepmdk mentioned this pull request Oct 27, 2023

[$500] IOS - Sign out - App crashes if user sign out of new account after sending a message while offline Expensify/App#29375

Closed

6 tasks

Julesssss mentioned this pull request Dec 11, 2023

[$1000] Web - Onyx: out-of-order updates Expensify/App#28737

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow infinite dependent keys when using withOnyx #385

Allow infinite dependent keys when using withOnyx #385

tgolen commented Oct 4, 2023 •

edited

Loading

tgolen Oct 4, 2023

allroundexperts Oct 5, 2023

tgolen Oct 5, 2023

tgolen Oct 5, 2023

allroundexperts Oct 5, 2023

tgolen Oct 5, 2023

allroundexperts Oct 5, 2023

tgolen Oct 5, 2023

tgolen Oct 5, 2023

allroundexperts Oct 5, 2023

tgolen Oct 4, 2023

tgolen commented Oct 5, 2023

allroundexperts commented Oct 5, 2023

allroundexperts commented Oct 5, 2023 •

edited

Loading

allroundexperts commented Oct 5, 2023 •

edited

Loading

tgolen commented Oct 6, 2023

tgolen commented Oct 9, 2023

allroundexperts commented Oct 9, 2023

MonilBhavsar left a comment

allroundexperts left a comment

MonilBhavsar left a comment

Allow infinite dependent keys when using withOnyx #385

Allow infinite dependent keys when using withOnyx #385

Conversation

tgolen commented Oct 4, 2023 • edited Loading

Details

Related Issues

Automated Tests

Linked PRs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Oct 5, 2023

allroundexperts commented Oct 5, 2023

allroundexperts commented Oct 5, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts commented Oct 5, 2023 • edited Loading

tgolen commented Oct 6, 2023

Results

Conclusion

tgolen commented Oct 9, 2023

allroundexperts commented Oct 9, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

MonilBhavsar left a comment

Choose a reason for hiding this comment

tgolen commented Oct 4, 2023 •

edited

Loading

allroundexperts commented Oct 5, 2023 •

edited

Loading

allroundexperts commented Oct 5, 2023 •

edited

Loading