Skip to content

Replace _.merge function with faster alternative#11185

Closed
Szymon20000 wants to merge 3 commits intoExpensify:mainfrom
Szymon20000:@szymon/speedup_merge
Closed

Replace _.merge function with faster alternative#11185
Szymon20000 wants to merge 3 commits intoExpensify:mainfrom
Szymon20000:@szymon/speedup_merge

Conversation

@Szymon20000
Copy link
Contributor

I find out that merge calls take a lot of time.

Screenshot 2022-09-21 at 16 26 26
Screenshot 2022-09-21 at 16 26 18
Screenshot 2022-09-21 at 16 26 09

I don't think onyx should merge anything during the initialization as most state management solutions I know just read read state from db. Before I understand How we can get rid of those merges I used _.merge replacement and optimised it so it's linear.

Details

Fixed Issues

$ GH_LINK

Tests

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

@github-actions
Copy link
Contributor

github-actions bot commented Sep 21, 2022

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@Szymon20000 Szymon20000 marked this pull request as ready for review September 26, 2022 09:20
@Szymon20000 Szymon20000 requested a review from a team as a code owner September 26, 2022 09:20
@melvin-bot melvin-bot bot requested review from Justicea83 and removed request for a team September 26, 2022 09:21
@Szymon20000
Copy link
Contributor Author

Merging is definitely much faster now the only thing that needs to be check ed if it's correct.
The app works fine but I'm not familiar enough with the app to be 100% sure.

@mountiny
Copy link
Contributor

mountiny commented Sep 26, 2022

@Szymon20000 Can you try the CLA check in this PR? I cant see why it should not work in the previous PR of yours...

+* @returns {*}
+*/
+function cloneIfNecessary(value, optionsArgument) {
+ var clone = optionsArgument && optionsArgument.clone === true;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does the .clone argument come from? Is that really needed? I don't think it's something we use today

Copy link
Contributor Author

@Szymon20000 Szymon20000 Sep 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole code is mostly taken from here https://medium.com/@lubaka.a/how-to-remove-lodash-performance-improvement-b306669ad0e1 That's why it's here. It's not used currently in onyx and can be removed/simplified.

+*/
+export function merge(target, source, optionsArgument) {
+ var array = Array.isArray(source);
+ var options = optionsArgument || {arrayMerge: defaultArrayMerge};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this so that you could pass a custom merge function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole code is mostly taken from here https://medium.com/@lubaka.a/how-to-remove-lodash-performance-improvement-b306669ad0e1 That's why it's here

+ var options = optionsArgument || {arrayMerge: defaultArrayMerge};
+ var arrayMerge = options.arrayMerge || defaultArrayMerge;
+ if (array) {
+ return Array.isArray(target) ? arrayMerge(target, source, optionsArgument) : cloneIfNecessary(source, optionsArgument);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain this logic a little bit? I'm not sure that I understand the intention of it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically if there is no array then just clone the one from source. If there is then merge every index separately.
Not sure if merging indices is necessary here but _.merge merges them so that's why it's here. I changed only arrayMerge as it was O(n^2) the rest is copied from the website I linked above.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok this makes a lot of sense to me just really odd lodash would not use this approach as well.

@Szymon20000 is there any case this method handles differently/ returns different result than lodash merge?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is easier for your testing @Szymon20000 but just to make sure, could you make these changes (once decided about them) in the react-native-onyx repo? https://github.com/Expensify/react-native-onyx

@Szymon20000
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@Szymon20000
Copy link
Contributor Author

I know this is easier for your testing @Szymon20000 but just to make sure, could you make these changes (once decided about them) in the react-native-onyx repo? https://github.com/Expensify/react-native-onyx

Sure it's only for testing

@Szymon20000
Copy link
Contributor Author

recheck

@mountiny
Copy link
Contributor

Wohoo, passed now, thanks! 🙇

@mountiny
Copy link
Contributor

Given the Medium article, are there any other lodash methods you would say are slowing down the App and replacing them with custom function would be noticeable? I assume merge is clearly the most noticeable because of Onyx, but maybe there are other places/bottlenecks where removing lodash could be beneficial.

@Szymon20000
Copy link
Contributor Author

Given the Medium article, are there any other lodash methods you would say are slowing down the App and replacing them with custom function would be noticeable? I assume merge is clearly the most noticeable because of Onyx, but maybe there are other places/bottlenecks where removing lodash could be beneficial.

I think It's always better to use built in solution for instance _.each -> array.forEach but the difference is not that big.

Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I think the next step here is actually to close out this PR and make a PR directly in react-native-onyx and then we will continue doing a complete review of it over there 👍

@Szymon20000
Copy link
Contributor Author

Will do it tomorrow morning

@Szymon20000
Copy link
Contributor Author

@tgolen

It looks like the problem maybe already solved by @iwiznia
https://github.com/Expensify/react-native-onyx/blob/main/lib/Onyx.js#L764
https://github.com/Expensify/react-native-onyx/blob/main/lib/mergeWithCustomized.js#L15

Will update react-native-onyx locally and see if it solves the problem.

@Szymon20000
Copy link
Contributor Author

No it does not solve the problem:
Screenshot 2022-09-28 at 10 39 57
Screenshot 2022-09-28 at 10 39 34
Screenshot 2022-09-28 at 10 39 30

@Szymon20000
Copy link
Contributor Author

@luacmartins luacmartins self-requested a review October 4, 2022 15:37
@luacmartins
Copy link
Contributor

Closing this issue in favor of Expensify/react-native-onyx#186

@luacmartins luacmartins closed this Oct 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants