Optimized listening to hasDraft property changes #30031

sebryu · 2023-10-19T22:18:29Z

Details

I've optimized OptionRowLHNData component by changing not optimal withReportCommentDrafts HOC which in this case subscribes to changes of all reports, to withOnyx -> comment that will only listen to singular REPORT_DRAFT_COMMENT change. In the result only one OptionRowLHNData component will need to be rendered (rather than all of them even if only one REPORT_DRAFT_COMMENT changes).

This is alternate approach to other open PR: #28469 but if my benchmarking are correct the results are much better. Possibly we can still use some of suggested improvements in the other PR.

Test case - change from empty report message input to single letter.

Profiler on x6 CPU throttling for @hurali97 changes (900ms for single commit + tense timeline):

Profiler on x6 CPU throttling for my changes (130ms for single commit + more relaxed timeline):

Fixed Issues

$ #28359
$ Proposal: #28359 (comment)

Tests

Verify that no errors appear in the JS console

QA Steps

Click on some conversation on sidebar navigation which is not in draft.
Type some message, do not send it.
Make sure conversation with draft is reordered, and properly marked (with pencil icon).

PR Author Checklist

Screenshots/Videos

Android: Native

android-app.mov

Android: mWeb Chrome

android-browser.mov

iOS: Native

ios-app.mov

iOS: mWeb Safari

ios-browser.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop2.mov

…ngle place

…yping

melvin-bot · 2023-10-23T11:21:32Z

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

mountiny · 2023-10-23T13:11:39Z

Adding @robertKozik as a C+ as you have reviewed the other PR from @hurali97

@hurali97 would you be able to review this one too?

@robertKozik Could you please priorotize this checklist?

robertKozik · 2023-10-23T15:42:29Z

Sure on it 👀

robertKozik · 2023-10-23T16:06:30Z

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 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

web.mov

Mobile Web - Chrome

android.-.web.mov

Mobile Web - Safari

ios.-.web.mov

Desktop

desktop.mov

iOS

ios.-.android.-.nativee.copy.mov

Android

ios.-.android.-.nativee.copy.mov

robertKozik

Tests well 🚀 I don't see any problems with drafts

mountiny

Thanks everyone!

OSBotify · 2023-10-23T18:48:36Z

✋ 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 · 2023-10-24T01:59:38Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.90-0 🚀

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

OSBotify · 2023-10-25T16:36:32Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.90-2 🚀

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

OSBotify · 2023-10-25T17:01:20Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:43:21Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

sebryu · 2023-10-31T10:56:00Z

src/components/LHNOptionsList/OptionRowLHNData.js

+            comment: {
+                key: ({reportID}) => `${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${reportID}`,
+            },


@adhorodyski this is already on main branch, and I think you can use that for part that Rory has mentioned #30242 (comment)

thank you so much for referencing it, will do!

Optimized listening to hasDraft property changes

0fbc48e

sebryu force-pushed the Sebryu-performance-optimize-rerenders-when-typing branch from 6393cd5 to 0fbc48e Compare October 20, 2023 14:08

blazejkustra approved these changes Oct 20, 2023

View reviewed changes

sebryu added 2 commits October 20, 2023 22:52

Extracted onyx selector ReportWithoutHasDraft for null checking in si…

ddfea3b

…ngle place

Merge branch 'main' into Sebryu-performance-optimize-rerenders-when-t…

d791ee3

…yping

sebryu marked this pull request as ready for review October 23, 2023 11:21

sebryu requested a review from a team as a code owner October 23, 2023 11:21

melvin-bot bot requested review from ArekChr and removed request for a team October 23, 2023 11:21

Prettier autofix

017cb9a

sebryu mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-11-30] [HOLD for payment 2023-11-01] Refactor heavy operations when user starts to type as main thread hangs on 4x and 6x cpu throttling #28359

Closed

mountiny requested review from robertKozik and removed request for ArekChr October 23, 2023 13:11

mountiny assigned sebryu Oct 23, 2023

mountiny self-requested a review October 23, 2023 13:12

robertKozik approved these changes Oct 23, 2023

View reviewed changes

mountiny approved these changes Oct 23, 2023

View reviewed changes

mountiny merged commit 81db5af into Expensify:main Oct 23, 2023

OSBotify mentioned this pull request Oct 24, 2023

Deploy Checklist: New Expensify 2023-10-24 #30224

Closed

43 tasks

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

sebryu mentioned this pull request Oct 27, 2023

Screen transitions trigger an excessive number of react commits #28158

Closed

sebryu commented Oct 31, 2023

View reviewed changes

DylanDylann mentioned this pull request Dec 8, 2023

Fix/30868: Incorrect group displayed #31424

Merged

50 tasks

Optimized listening to hasDraft property changes #30031

Optimized listening to hasDraft property changes #30031

Uh oh!

Conversation

sebryu commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 23, 2023

Uh oh!

mountiny commented Oct 23, 2023

Uh oh!

robertKozik commented Oct 23, 2023

Uh oh!

robertKozik commented Oct 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

OSBotify commented Oct 24, 2023

Uh oh!

OSBotify commented Oct 25, 2023

Uh oh!

OSBotify commented Oct 25, 2023

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

sebryu Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

adhorodyski Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sebryu commented Oct 19, 2023 •

edited

Loading

robertKozik commented Oct 23, 2023 •

edited

Loading