perf: remove getSearchText function #46409

TMisiukiewicz · 2024-07-29T13:15:31Z

Details

Since all search pages are migrated to filterOptions now, we are able to remove usage of getSearchText from createOption to speed up the time of building option list.

Additionally, all tests for search were migrated to filterOptions.

Removing getSearchText speeds up creating option list by around 40%. In the context of a trace provided for a linked issue, it reduces accumulated createOption time from 5.7s to 4s (~42% improvement)

Fixed Issues

$ #45528
PROPOSAL:

Tests

Go to Chat Finder
Type something matching the list and verify it appears in the results
Go back
Open FAB and go to Start Chat
Type something matching the list and verify it appears in the results
Add one of the results to the group and verify it appears in the list of selected items
Go back
Open FAB and go to Submit expense
Fill in an amount manually and go to next screen
Type something matching the list and verify it appears in the results

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to Chat Finder
Type something matching the list and verify it appears in the results
Go back
Open FAB and go to Start Chat
Type something matching the list and verify it appears in the results
Add one of the results to the group and verify it appears in the list of selected items
Go back
Open FAB and go to Submit expense
Fill in an amount manually and go to next screen
Type something matching the list and verify it appears in the results

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

adhorodyski · 2024-07-29T14:06:05Z

Backlinking to #45528

melvin-bot · 2024-07-30T09:41:15Z

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

mkhutornyi · 2024-07-30T19:35:07Z

src/libs/OptionsListUtils.ts

-        if (personalDetail.login) {
-            // The regex below is used to remove dots only from the local part of the user email (local-part@domain)
-            // so that we can match emails that have dots without explicitly writing the dots (e.g: fistlast@domain will match first.last@domain)
-            // More info https://github.com/Expensify/App/issues/8007


no need to link this old issue anymore?

mkhutornyi · 2024-07-30T19:42:44Z

src/libs/OptionsListUtils.ts

-        if (isThread) {
-            const title = ReportUtils.getReportName(report);
-            const chatRoomSubtitle = ReportUtils.getChatRoomSubtitle(report);
-
-            Array.prototype.push.apply(searchTerms, title.split(/[,\s]/));
-            Array.prototype.push.apply(searchTerms, chatRoomSubtitle?.split(/[,\s]/) ?? ['']);
-        } else if (isChatRoomOrPolicyExpenseChat) {
-            const chatRoomSubtitle = ReportUtils.getChatRoomSubtitle(report);
-
-            Array.prototype.push.apply(searchTerms, chatRoomSubtitle?.split(/[,\s]/) ?? ['']);
-        }


We had made threads searchable in #19117.
Please make sure that this removal doesn't cause regression.

neil-marcellini

Overall it looks pretty good, but I'm having trouble tracking all the changes. Could you please explain a bit more about why it's ok to remove this function, how we can be sure it's not used anywhere, and provide an overview of how and why the tests were changed?

neil-marcellini · 2024-07-30T21:04:55Z

tests/unit/OptionsListUtilsTest.ts

-                // Then we expect to have the personal detail with period filtered
-                expect(results.recentReports.length).toBe(1);
-                expect(results.recentReports[0].text).toBe('The Flash');
-            });
    });


The getSearchOptions function is still in use, could you please explain why it's ok to remove these tests?

I see you added some tests at the bottom which look similar, but again I'm having trouble determining what has changed. Maybe with more context it will be clear to me.

TMisiukiewicz · 2024-07-31T13:44:38Z

hi @neil-marcellini, let me give you some background here. For the last couple of months I was working on optimizing search lists. The main bottlenecks here were:

re-generating search options each time user types in the input
each time search options were re-generated, a searchText was generated from scratch for each option using getSearchText

For heavy loaded accounts, with thousands of reports and personal details, the total execution time for getSearchText could be measured in seconds.

The actions we took were:

creating cache mechanism, so the options are created only once perf: Cache search options #38207
migrate lists from searchText-based search to filtering options when typing with filterOptions function, e.g. perf: Intive to workspace options filtering #40793

Since recently we migrated all the lists to the filtering, we should be safe to get rid of generating search text for options. Lists like Category, Tags, or Tag are still using searchText property, because the search in here is pretty straightforward and does not require any heavy calculations.

Since removing getSearchText allowed to remove part of a search logic from getOptions, the unit tests that were responsible for validating search results started to fail. To make sure the new implementation works properly, I re-wrote all of these tests into filterOptions

neil-marcellini

Ok thanks for explaining. The code looks good. Hopefully we didn't miss anything and there are no regressions.

neil-marcellini · 2024-07-31T18:22:38Z

@mkhutornyi please DM me on Slack when you finish your review and it's ready to merge.

TMisiukiewicz · 2024-08-02T07:42:08Z

@mkhutornyi could you please take a look on this PR when you have a moment? Thanks!

adhorodyski · 2024-08-02T07:47:44Z

Just to put this PR into more context, the estimated gain for this is a major speedup in how the Chat Finder page operates on bigger accounts.

Generally each interaction should be much snappier as we're stripping down ~40% of the existing compute time for generating the list of results.

neil-marcellini · 2024-08-02T16:26:01Z

Bumped the C+ in Slack here. If he's too busy we can get someone else.

mkhutornyi · 2024-08-05T05:44:13Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.mp4

Android: mWeb Chrome

mchrome.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

mkhutornyi · 2024-08-05T08:02:17Z

Looking good so far. Still testing with some more accounts

adhorodyski · 2024-08-05T12:25:18Z

@mkhutornyi thanks for diving into this, I'm hoping we can get this one merged today 🤞

hurali97 · 2024-08-05T14:10:35Z

src/libs/OptionsListUtils.ts

@@ -2440,7 +2368,7 @@ function formatSectionsFromSearchTerm(
    // This will add them to the list of options, deduping them if they already exist in the other lists
    const selectedParticipantsWithoutDetails = selectedOptions.filter((participant) => {
        const accountID = participant.accountID ?? null;
-        const isPartOfSearchTerm = participant.searchText?.toLowerCase().includes(searchTerm.trim().toLowerCase());
+        const isPartOfSearchTerm = getPersonalDetailSearchTerms(participant).join(' ').toLowerCase().includes(searchTerm.trim().toLowerCase());


Can we move searchTerm.trim().toLowerCase() to outside of the filter ? It seems redundant and we can potentially save some ms here.

yep nice catch! No need to transform it each time

TMisiukiewicz · 2024-08-05T15:26:34Z

resolved comment & updated with main

OSBotify · 2024-08-06T04:28:11Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.17-0 🚀

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

…rchtext" This reverts commit eb16bd6, reversing changes made to 412fc60.

OSBotify · 2024-08-07T22:04:01Z

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

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

OSBotify · 2024-08-08T04:53:38Z

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

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

OSBotify · 2024-08-08T20:05:02Z

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

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

TMisiukiewicz added 4 commits July 29, 2024 14:12

remove usage of searchText for personal details

4981a04

remove usage of searchtext in current user option

dad7d56

remove getSearchText function

a5e171e

remove unused search code

28aa5a4

adhorodyski approved these changes Jul 29, 2024

View reviewed changes

TMisiukiewicz added 2 commits July 30, 2024 10:10

migrate OptionListUtils search tests to filterOptions

5c333f3

Merge remote-tracking branch 'upstream/main' into perf/getsearchtext

fc0599f

TMisiukiewicz marked this pull request as ready for review July 30, 2024 09:41

TMisiukiewicz requested a review from a team as a code owner July 30, 2024 09:41

melvin-bot bot requested review from mkhutornyi and removed request for a team July 30, 2024 09:41

muttmuure requested a review from neil-marcellini July 30, 2024 11:19

mkhutornyi reviewed Jul 30, 2024

View reviewed changes

neil-marcellini reviewed Jul 30, 2024

View reviewed changes

link issue for email regex

b4997e2

neil-marcellini previously approved these changes Jul 31, 2024

View reviewed changes

neil-marcellini requested a review from mkhutornyi July 31, 2024 18:21

hurali97 reviewed Aug 5, 2024

View reviewed changes

TMisiukiewicz added 2 commits August 5, 2024 17:17

Merge remote-tracking branch 'upstream/main' into perf/getsearchtext

c3885ac

move normalizing search term out of loops

23fb1e9

TMisiukiewicz dismissed neil-marcellini’s stale review via 23fb1e9 August 5, 2024 15:25

mkhutornyi approved these changes Aug 5, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini August 5, 2024 18:30

neil-marcellini approved these changes Aug 5, 2024

View reviewed changes

neil-marcellini merged commit eb16bd6 into Expensify:main Aug 5, 2024
16 checks passed

adhorodyski deleted the perf/getsearchtext branch August 5, 2024 20:42

github-actions bot mentioned this pull request Aug 6, 2024

Deploy Checklist: New Expensify 2024-08-06 #46849

Closed

83 tasks

trjExpensify mentioned this pull request Aug 7, 2024

[HOLD for payment 2023-08-23] Group chat - Unable to search for members when inviting group members #46972

Closed

6 tasks

marcochavezf added a commit that referenced this pull request Aug 7, 2024

Revert "Merge pull request #46409 from callstack-internal/perf/getsea…

212864d

…rchtext" This reverts commit eb16bd6, reversing changes made to 412fc60.

marcochavezf mentioned this pull request Aug 7, 2024

Revert "Merge pull request #46409 from callstack-internal/perf/getsea… #46996

Closed

48 tasks

melvin-bot bot mentioned this pull request Aug 7, 2024

[HOLD for payment 2024-08-14] [HOLD for payment 2024-08-09] Optimize frontend performance in most recent mode #45528

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf: remove getSearchText function #46409

perf: remove getSearchText function #46409

TMisiukiewicz commented Jul 29, 2024 •

edited

Loading

adhorodyski commented Jul 29, 2024

melvin-bot bot commented Jul 30, 2024

mkhutornyi Jul 30, 2024

mkhutornyi Jul 30, 2024

neil-marcellini left a comment

neil-marcellini Jul 30, 2024

neil-marcellini Jul 30, 2024

TMisiukiewicz commented Jul 31, 2024

neil-marcellini left a comment

neil-marcellini commented Jul 31, 2024

TMisiukiewicz commented Aug 2, 2024

adhorodyski commented Aug 2, 2024

neil-marcellini commented Aug 2, 2024

mkhutornyi commented Aug 5, 2024 •

edited

Loading

mkhutornyi commented Aug 5, 2024

adhorodyski commented Aug 5, 2024

hurali97 Aug 5, 2024

adhorodyski Aug 5, 2024

TMisiukiewicz commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

perf: remove getSearchText function #46409

perf: remove getSearchText function #46409

Conversation

TMisiukiewicz commented Jul 29, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

adhorodyski commented Jul 29, 2024

melvin-bot bot commented Jul 30, 2024

mkhutornyi Jul 30, 2024

Choose a reason for hiding this comment

mkhutornyi Jul 30, 2024

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini Jul 30, 2024

Choose a reason for hiding this comment

neil-marcellini Jul 30, 2024

Choose a reason for hiding this comment

TMisiukiewicz commented Jul 31, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini commented Jul 31, 2024

TMisiukiewicz commented Aug 2, 2024

adhorodyski commented Aug 2, 2024

neil-marcellini commented Aug 2, 2024

mkhutornyi commented Aug 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mkhutornyi commented Aug 5, 2024

adhorodyski commented Aug 5, 2024

hurali97 Aug 5, 2024

Choose a reason for hiding this comment

adhorodyski Aug 5, 2024

Choose a reason for hiding this comment

TMisiukiewicz commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

TMisiukiewicz commented Jul 29, 2024 •

edited

Loading

mkhutornyi commented Aug 5, 2024 •

edited

Loading