perf: refactor heavy operations when user starts to type

[hurali97]

Details

This fixes the bottleneck which happens on slower devices when user switches a Report and starts to type and as a result the main thread gets blocked. The underlying root cause is mainly the chatReports being re-created because of Onyx.merge being called for setting draft status.

There are also other optimisations including removing the lodashGet where it takes noticeable milliseconds, refactoring two loops into one in getOrderedReportIDs, call updateUnread only if unread count is changed from the previous one and other changes which are mentioned in the proposal.

Note:
In the proposal, we proposed to pass only allReportDict keys to JSON.Stringify but it turns out that we can't really do that since we have a lot of unit test failing because of it and the most of the app functionality depends on re-ordering the reportIDs based on changing in values for a report.

Given that we are still able to score better results because we separated out the functionality for draft given a smoother user experience when user starts to type.

Before

recording-before.mp4

After

recording-after.mp4

Below is the screenshot after adding initialValue to withOnyx:

Fixed Issues

$ #28359
PROPOSAL: #28359

Tests

Test Steps

• Go to any chat and type in a letter

• On web and desktop, Pencil icon should be visible in the LHN

• On Mobile, you've to navigate back to see the Pencil icon

• Removing the entered letter from compose, should remove the Pencil icon from the LHN, hence the draft status

• Verify that no errors appear in the JS console

Offline tests

Same as test

QA Steps

• Verify that no errors appear in the JS console

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 the expected offline behavior in the Offline steps 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • 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 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • 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 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
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

recording-after.mp4

Mobile Web - Chrome

mobile-chrome.mov

Mobile Web - Safari

mobile-safari.mp4

Desktop

desktop-recording.mov

iOS

ios-recording.mp4

Android

android-recording.mp4

[melvin-bot]

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

[robertKozik]

@hurali97 Can you resolve conflicts? I'll test it and do the reviewer checklist today

[gedu]

@robertKozik Hur is off this week, will try to find someone to solve the conflicts

[robertKozik]

Thanks @gedu !

[gedu]

@robertKozik I fix it but don't have permission to push to Hur branch, he should be back on Monday

[mountiny]

Looking at this PR from @sebryu https://github.com/Expensify/App/pull/30031/files could we use both potentially?

[hurali97]

Looking at this PR from @sebryu https://github.com/Expensify/App/pull/30031/files could we use both potentially?

@mountiny I have removed the code that conflicts with Sebs' approach.

[mountiny]

test build running here https://github.com/Expensify/App/actions/runs/6645315083

@robertKozik could you test this gain please?

[OSBotify]

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/28469/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/28469/index.html
desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/28469/NewExpensify.dmg	https://28469.pr-testing.expensify.com

[robertKozik]

On it 👀

[robertKozik]

@mountiny Tests well, I cannot find any regressions nor problems with that.

@hurali97 I see the TypeScript checks are failing, can you look into it?

[mountiny]

@hurali97 sorry for late review, could you please resolve the conflicts?

[mountiny]

code changes look good to me, thank you very much for your patience on this one

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[situchan]

This caused serious regression. App crashes when request expense

Screen.Recording.2023-11-03.at.8.40.55.PM.mov

Anyone please raise quick fix? Or can I?

[Gonals]

I just encountered this issue too. Pushing a fix soon

[situchan]

@Gonals being reverted in #30852

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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