Revert "Revert "Search suffix tree implementation"" #51332

hannojg · 2024-10-23T13:08:30Z

Details

Note: This is the second attempt to merge this after the original PR here:

Search suffix tree implementation #48652

has been reverted for this issue:

Search - Search does not returns group when entering group members #51175

I believe the revert to be a mistake, as the functionality to search chats by their participants had earlier been removed here (please correct me if i am wrong):

perf: remove search by chats participants #47229

This PR aims at improving the local search speed.
On a lower end android phone with a hightraffic account searching is currently taking around 344ms in the release build.
Our proposed suffix tree search implementation takes 0.14ms for searching on that same device.
That is a 2456x improvement.

Fixed Issues

$ #46591
PROPOSAL:

Tests

Open the chat finder page (search icon on the start page when authenticated)
Perform searches, confirm that everything is found, make sure to also search for numbers
Search for an email address (e.g. [email protected]), make sure it's found. Then search for hannomargeloio (removing all special chars), and make sure its still found
You might want to open the production version and compare your search results with the dev version to make sure you got the same results

Offline tests

Same as testing steps

QA Steps

Same as testing steps

PR Author Checklist

Screenshots/Videos

Android: Native

Screen_Recording_20240927_212736_New.Expensify.Dev.mp4

Android: mWeb Chrome

Screen_Recording_20240927_211510_Chrome.mp4

iOS: Native

Screen.Recording.2024-09-27.at.21.28.56.mov

iOS: mWeb Safari

ScreenRecording_09-27-2024.21-34-17_1.MP4

MacOS: Chrome / Safari

Screen.Recording.2024-09-27.at.21.08.10.mov

MacOS: Desktop

Screen.Recording.2024-09-27.at.21.28.10.mov

This reverts commit a16871f.

melvin-bot · 2024-10-23T13:08:35Z

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

ahmedGaber93 · 2024-10-23T13:49:33Z

@mkhutornyi can you please ignore this issue as it related to #48652 regression.

ahmedGaber93 · 2024-10-23T14:46:36Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

ahmedGaber93 · 2024-10-23T15:12:24Z

The regression root cause is not related to "search chats by their participants" feature, but it related to search by report displayName.

When we create a group, the report name will be participant1, participant2, participant3, ...

if we search by text participant1 participant2, the search process will be different in our PR and filterOptions

the filterOptions will split it to two search text participant1 and participant2 because it will split it by space here

App/src/libs/OptionsListUtils.ts

Line 2452 in d20c564

const searchTerms = searchValue ? searchValue.split(' ') : [];
our PR will search for participant1 participant2 as a one search text, not two participant1 and participant2

I will complete the reviewer checklist and let the decision for you if we need to implement split search text by space (we can handle it in a follow-up) @hannojg @marcaaron

marcaaron · 2024-10-23T18:54:18Z

Hmm, personally, I think it's fine to handle that in a follow up as an improvement - but there might be some people who are expecting it to work that way.

OSBotify · 2024-10-23T19:04:26Z

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

hannojg · 2024-10-24T09:03:15Z

Hey @ahmedGaber93 thanks for explaining the problem to me more detailed. I created a follow UP PR here which fixes the specific use case where searching with white spaces doesn't bring up the groups name as search result:

fix: exclude comma from search values #51393

Note however, that there is still a slight difference in how search results are returned due to this change:

The group name could be found, but its not returning any of the other results as seen on staging.
That's because we don't search separately for each term which was separated with a whitespace. This functionality had been added in this PR":

perf: Implement filtering in search page #37909

I can't find any details to why this has been added. Personally, I'd like to avoid adding this, as it creates more overhead where we have to de-duplicate search results later on. Wdyt @marcaaron? (It can be added to these new changes as well, I just feel that it was functionality that hasn't been added on a clear feature request in the first place)

marcaaron · 2024-10-25T00:39:37Z

tbh I'm not entirely sure how it should perform in this particular case. maybe bring it up in Slack?

github-actions · 2024-10-25T02:09:08Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.54-0 🚀

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

luacmartins · 2024-10-25T18:37:41Z

@hannojg @marcaaron I think this PR might be related to this blocker. I'm seeing very different results when making the same report search on staging vs production (and it seems like the prod results are more "correct")

yuwenmemon · 2024-10-25T23:03:20Z

I also think this may be related to the blocker here: #51482

ahmedGaber93 · 2024-10-27T18:12:32Z

I test #51471 and #51482 on iOS with this PR and I can't reproduce any of them. So I think they are not related to this PR.

hannojg · 2024-10-28T08:55:11Z

@yuwenmemon this PR has only changes internals of how search results are filtered. It has touched no UI related code. I don't think its related.

jasperhuangg · 2024-10-28T17:23:06Z

Might be related to a crash we're seeing on Android, gonna build and test a revert

#51584

github-actions · 2024-10-29T09:14:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

github-actions · 2024-10-29T11:39:05Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

Revert "Revert "Search suffix tree implementation""

733d420

This reverts commit a16871f.

hannojg requested a review from a team as a code owner October 23, 2024 13:08

melvin-bot bot requested review from mkhutornyi and removed request for a team October 23, 2024 13:08

hannojg mentioned this pull request Oct 23, 2024

[Performance] Typing in search is very laggy for big accounts #46591

Open

6 tasks

ahmedGaber93 approved these changes Oct 23, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron October 23, 2024 15:30

marcaaron assigned hannojg Oct 23, 2024

marcaaron approved these changes Oct 23, 2024

View reviewed changes

marcaaron merged commit 924f909 into Expensify:main Oct 23, 2024
17 checks passed

hannojg mentioned this pull request Oct 24, 2024

fix: exclude comma from search values #51393

Closed

48 tasks

github-actions bot mentioned this pull request Oct 25, 2024

Deploy Checklist: New Expensify 2024-10-25 #51448

Closed

49 tasks

luacmartins mentioned this pull request Oct 25, 2024

Search - selfDM is not shown in search #51471

Closed

8 tasks

lanitochka17 mentioned this pull request Oct 26, 2024

Search - Email address not found when searching without the special characters #51532

Open

8 tasks

This was referenced Oct 28, 2024

Revert "Revert "Revert "Search suffix tree implementation""" #51590

Merged

Android Hybrid - Search - App crashes when switching between expenses of the same report. #51584

Open

NikkiWines mentioned this pull request Oct 29, 2024

Hybrid iOS - App gets unresponsive after logging as WS member and dismissing explanation modal #51527

Closed

8 tasks

hannojg mentioned this pull request Nov 4, 2024

Search suffix tree implementation #51954

Open

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revert "Revert "Search suffix tree implementation"" #51332

Revert "Revert "Search suffix tree implementation"" #51332

hannojg commented Oct 23, 2024

melvin-bot bot commented Oct 23, 2024

ahmedGaber93 commented Oct 23, 2024

ahmedGaber93 commented Oct 23, 2024 •

edited

Loading

ahmedGaber93 commented Oct 23, 2024

marcaaron commented Oct 23, 2024

OSBotify commented Oct 23, 2024

hannojg commented Oct 24, 2024

marcaaron commented Oct 25, 2024

github-actions bot commented Oct 25, 2024

luacmartins commented Oct 25, 2024

yuwenmemon commented Oct 25, 2024

ahmedGaber93 commented Oct 27, 2024

hannojg commented Oct 28, 2024

jasperhuangg commented Oct 28, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

Revert "Revert "Search suffix tree implementation"" #51332

Revert "Revert "Search suffix tree implementation"" #51332

Conversation

hannojg commented Oct 23, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 23, 2024

ahmedGaber93 commented Oct 23, 2024

ahmedGaber93 commented Oct 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ahmedGaber93 commented Oct 23, 2024

marcaaron commented Oct 23, 2024

OSBotify commented Oct 23, 2024

hannojg commented Oct 24, 2024

marcaaron commented Oct 25, 2024

github-actions bot commented Oct 25, 2024

luacmartins commented Oct 25, 2024

yuwenmemon commented Oct 25, 2024

ahmedGaber93 commented Oct 27, 2024

hannojg commented Oct 28, 2024

jasperhuangg commented Oct 28, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

ahmedGaber93 commented Oct 23, 2024 •

edited

Loading