(perf) Debounce search in OptionList #32962

TMisiukiewicz · 2023-12-13T09:57:36Z

Details

Adding debounce for all OptionList component occurencies, to reduce expensive calculations on each keystroke.

Fixed Issues

$ #32806
PROPOSAL:

Tests

Log in the High traffic account
Open Search
Type email address of an existing user, e.g. [email protected]
Make sure typing goes smoothly and results are displayed on the list
Open FAB and select "Start Chat"
Repeat steps 3 & 4
Open FAB and select "Request Money"
Go to "Manual" tab and enter any amount of money
Press "Next" and repeat steps 3 & 4
Open FAB and select "Send Money"
Enter any amount of money and press "Next"
Repeat steps 3 & 4
Open any chat
Open chat menu and select "Assign task"
Add title and press "Next"
Press "Assignee"
Repeat steps 3 & 4
Open FAB ans select "Request Money"
Go to "Manual" tab and enter amount and press next
Select any workspace to split and press "Add to split"
Press "Show more" and press "Category"
Type any item existing in the list, e.g. "Car"
Make sure typing goes smoothly and results are displayed on the list

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Log in the High traffic account
Open Search
Type email address of an existing user, e.g. [email protected]
Make sure typing goes smoothly and results are displayed on the list
Open FAB and select "Start Chat"
Repeat steps 3 & 4
Open FAB and select "Request Money"
Go to "Manual" tab and enter any amount of money
Press "Next" and repeat steps 3 & 4
Open FAB and select "Send Money"
Enter any amount of money and press "Next"
Repeat steps 3 & 4
Open any chat
Open chat menu and select "Assign task"
Add title and press "Next"
Press "Assignee"
Repeat steps 3 & 4
Open FAB ans select "Request Money"
Go to "Manual" tab and enter amount and press next
Select any workspace to split and press "Add to split"
Press "Show more" and press "Category"
Type any item existing in the list, e.g. "Car"
Make sure typing goes smoothly and results are displayed on the list

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

ANDROID.mov

Android: mWeb Chrome

ANDROID-WEB.mov

iOS: Native

IOS.mov

iOS: mWeb Safari

IOS-WEB.mov

MacOS: Chrome / Safari

WEB.mov

MacOS: Desktop

DESKTOP.mov

melvin-bot · 2023-12-14T11:58:10Z

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

src/CONST.ts

src/components/OptionsSelector/optionsSelectorPropTypes.js

src/pages/SearchPage.js

src/pages/tasks/TaskAssigneeSelectorModal.js

src/pages/tasks/TaskShareDestinationSelectorModal.js

src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js

TMisiukiewicz · 2023-12-15T09:16:36Z

thanks @s77rt , I applied all the changes you mentioned

s77rt · 2023-12-15T18:57:49Z

When making multiple requests to SearchForReports we should cancel the previous ones. There should be only one read command at a time. I think this should be fixed globally, every read command can only exist once at most. If we make multiple read requests for the same command the previous ones should be cancelled.

Screen.Recording.2023-12-15.at.7.49.46.PM.mov

src/CONST.ts

s77rt · 2023-12-15T19:23:38Z

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(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 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.mov

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

s77rt · 2023-12-15T19:25:07Z

This #32962 (comment) should probably be handled separately

TMisiukiewicz · 2023-12-18T13:28:15Z

Addressed the comment. I agree the comment looks like something that should be tackled separately 👍

mountiny

One comment

mountiny · 2023-12-18T14:02:13Z

src/components/OptionRow.js

-        !_.isEqual(prevProps.option.icons, nextProps.option.icons) &&
+        _.isEqual(prevProps.option.icons, nextProps.option.icons) &&


What is this change about? This must have been causing some bug if it was incorrect 😄

This was breaking the memoisation of the OptionRow - it was rerendering the whole OptionRow when typing in the SearchInput, but in fact the icons array and its values remained the same

mountiny · 2023-12-18T14:23:50Z

Thanks @TMisiukiewicz and @s77rt really appreciate you digging into these

OSBotify · 2023-12-18T14:27:51Z

✋ 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-12-19T02:44:18Z

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

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

OSBotify · 2023-12-19T03:47:39Z

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

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

pecanoro · 2023-12-19T14:24:09Z

Not totally sure but I think this PR might have caused this regression #33282

OSBotify · 2023-12-21T05:15:14Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

TMisiukiewicz changed the title ~~Perf/debounce search~~ (perf) Debounce search in OptionList Dec 13, 2023

TMisiukiewicz marked this pull request as ready for review December 14, 2023 11:58

TMisiukiewicz requested a review from a team as a code owner December 14, 2023 11:58

melvin-bot bot requested review from s77rt and removed request for a team December 14, 2023 11:58

s77rt suggested changes Dec 15, 2023

View reviewed changes

TMisiukiewicz added 5 commits December 15, 2023 09:46

optimize search in BaseOptionSelector and implement in money request

9ad0872

remove unnecessary value prop from money request

953e729

remove debounce from SearchPage

7ccef7e

update all occurencies of OptionsSelector

770a525

code review updates

d6beb16

TMisiukiewicz force-pushed the perf/debounce-search branch from aa1c455 to d6beb16 Compare December 15, 2023 09:13

TMisiukiewicz requested a review from s77rt December 15, 2023 09:16

s77rt reviewed Dec 15, 2023

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

s77rt approved these changes Dec 15, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny December 15, 2023 19:31

mountiny assigned TMisiukiewicz Dec 18, 2023

TMisiukiewicz added 2 commits December 18, 2023 14:21

Merge remote-tracking branch 'upstream/main' into perf/debounce-search

1b377a6

update search debounce to 300 ms

6018a64

fix linting

4aad839

mountiny approved these changes Dec 18, 2023

View reviewed changes

mountiny merged commit 37d34e8 into Expensify:main Dec 18, 2023
18 checks passed

koko57 mentioned this pull request Dec 18, 2023

Migrate SearchPage.js to function component #27924

Merged

57 tasks

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

situchan mentioned this pull request Dec 19, 2023

[$500] iOS - Request Money - Searching for specific HT account while using HT account has an odd behavior #30803

Closed

6 tasks

pecanoro mentioned this pull request Dec 19, 2023

[HOLD for payment 2024-01-03] Task - Assignee list opens after some delay #33282

Closed

6 tasks

mountiny mentioned this pull request Dec 19, 2023

[CP Staging] Revert "(perf) Debounce search in OptionList" #33297

Merged

amyevans mentioned this pull request Dec 19, 2023

Web - App works with delay, when reinvite the member to WS #33291

Closed

6 tasks

lanitochka17 mentioned this pull request Dec 19, 2023

Send Money - The participant selection page for Send money flow is noticeably slower #33322

Closed

6 tasks

TMisiukiewicz mentioned this pull request Dec 20, 2023

(perf) Implement debounce in OptionList search #33347

Merged

50 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2024-01-03] [HOLD for payment 2023-12-28] [Performance] Search input performance optimization #32806

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(perf) Debounce search in OptionList #32962

(perf) Debounce search in OptionList #32962

TMisiukiewicz commented Dec 13, 2023 •

edited

Loading

melvin-bot bot commented Dec 14, 2023

TMisiukiewicz commented Dec 15, 2023

s77rt commented Dec 15, 2023

s77rt commented Dec 15, 2023

s77rt commented Dec 15, 2023

TMisiukiewicz commented Dec 18, 2023

mountiny left a comment

mountiny Dec 18, 2023

TMisiukiewicz Dec 18, 2023

mountiny Dec 18, 2023

mountiny commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

pecanoro commented Dec 19, 2023

OSBotify commented Dec 21, 2023

		!_.isEqual(prevProps.option.icons, nextProps.option.icons) &&
		_.isEqual(prevProps.option.icons, nextProps.option.icons) &&

(perf) Debounce search in OptionList #32962

(perf) Debounce search in OptionList #32962

Conversation

TMisiukiewicz commented Dec 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 14, 2023

TMisiukiewicz commented Dec 15, 2023

s77rt commented Dec 15, 2023

s77rt commented Dec 15, 2023

Reviewer Checklist

Screenshots/Videos

s77rt commented Dec 15, 2023

TMisiukiewicz commented Dec 18, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 18, 2023

Choose a reason for hiding this comment

TMisiukiewicz Dec 18, 2023

Choose a reason for hiding this comment

mountiny Dec 18, 2023

Choose a reason for hiding this comment

mountiny commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

pecanoro commented Dec 19, 2023

OSBotify commented Dec 21, 2023

TMisiukiewicz commented Dec 13, 2023 •

edited

Loading