Search suffix tree implementation #51954

hannojg · 2024-11-04T14:09:30Z

Explanation of Change

Reapplying the changes from this reverted PR:

Search suffix tree implementation #48652

This PR makes sure to fix the following regressions as well:

Revert "Revert "Search suffix tree implementation"" #51332 (comment)
Search - selfDM is not shown in search #51471 (comment)
~~Search-Search result shows fallback avatar and email instead of custom avatar and display name #51123~~
- (Turns out this wasn't caused by these changes)

Fixed Issues

$ #46591
PROPOSAL:

Tests

Test 1:

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. hanno@margelo.io), 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 similar results (see note at the top)

Test 2:

Search for the user's own email address, make sure that self DM results are at the top (if its a fresh user create a few threads)

Test 3:

Create a new group with three participants
Search for the group name, including the commas, confirm that it shows in the search 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 20af9f6.

This reverts commit a2d8012.

melvin-bot · 2024-11-05T11:01:25Z

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

hannojg · 2024-11-05T11:01:59Z

cc @marcaaron since you also reviewed the first PR (and rory is on parental leave)

ahmedGaber93 · 2024-11-07T01:02:32Z

BUG: search result display previous search result above the current search result

login with high traffic account
type marc on search, then remove it (don't close the search modal, just remove it) and type shawn

Expected: search for shawn should display result for shawn only
Current: it displays result for marc and shawn

screenshots

BUG: Ordering result prefer includes over startsWith

screenshots

BUG: Duplicated result

screenshots

@hannojg

hannojg · 2024-11-07T07:35:15Z

Thanks for testing, let me fix those!

hannojg · 2024-11-07T10:04:27Z

I split out a few changes here first:

perf: cleanup option list #52168

ahmedGaber93 · 2024-11-08T01:33:35Z

Status of fixed issues:

BUG: search result display previous search result above the current search result
BUG: Ordering result prefer includes over startsWith
BUG: Duplicated result

hannojg · 2024-11-08T09:57:36Z

Thanks for testing! On the ordering bug, i looked into it and came to the conclusion that i first need to cleanup the OptionListUtils a little, its a lot of spaghetti 🍝

How it currently works is:

(getOptions) first convert all reports and users into a different format (the ReportUtils.OptionsData format)
(getOptions) then order all search options
(filterOptions) then filter them
(filterOptions) then apply a second ordering (i think this double ordering we can maybe get rid of in the cleanup)

All of this is happening in like 2 functions and is very coupled.

The reason why the ordering is broken with our SuffixTree is that right now it works like this:

(getOptions) first convert all reports and users into the OptionsData format
(getOptions) then order all search options
BREAKING(FastSearch): filter options using our search tree - the search tree doesn't keep the order in-tact, so its breaking here
(FastSearch) apply the second ordering

My current approach is to cleanup the current code so the search works like this (before applying the changes from this PR):

convert all to OptionsData
- (unfortunately we have to do this first for multiple reasons... will see if i can make a bigger refactor so that only search results that we currently need to display will be converted which would be better for performance)
filter them
then order them at once

This way the ordering should always give the same results.
[Also it should be more performant to just filter the limited search results, instead of ordering everything at the start.]

(Will keep opening a couple of cleanup PRs today)

Cleanup PRs:

perf: cleanup option list #52168
clean: moved Category OptionListUtils over to CategoryOptionListUtils #52250
cleanup: refactor getTagListSections to TagsOptionsListUtils #52287
cleanup: refactor TaxOptions to their own utils #52309
cleanup: moved report field options to their own file #52311
cleanup: consolidate all getFilteredOptions and getOptions calls into one function getOptions #53056
- Cleanup usages of getOptions and getFilteredOptions
- Remove searchValue from getOptions, decide if there is a good reason for getFilteredOptions to exists / combine getOptions + filterOptions in getFilteredOptions
Investigate if ordering in filterOptions is really necessary / refactor for filtering and ordering to truly work separately (so we finally can fix the ordering issue in this PR):
- cleanup: split filtering & ordering in OptionsListUtils #53371

hannojg · 2024-12-17T10:42:34Z

Raised a question here on slack about the failing eslint tests

hannojg · 2024-12-17T11:51:34Z

As discussed here OptionsListUtils will be migrated separately

ahmedGaber93 · 2024-12-17T17:27:32Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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-12-17T17:53:26Z

Thanks for the updates, I think userToInvite have been broken in the last changes

20241217194031580.mp4

This is a more effective implementation for https://github.com/Expensify/App/pull/54147/files which i reverted in this PR

hannojg · 2024-12-20T21:34:14Z

This should be good again for testing @ahmedGaber93

ahmedGaber93

Tested well, All yours @marcaaron

marcaaron · 2024-12-23T20:52:22Z

src/hooks/useFastSearchFromOptions.ts

+ * Builds a suffix tree and returns a function to search in it.
+ *
+ * @example
+ * ```


NAB

Suggested change

* ```

*

marcaaron · 2024-12-23T20:53:32Z

src/hooks/useFastSearchFromOptions.ts

+            }
+
+            // The user might separated words with spaces to do a search such as: "jo d" -> "john doe"
+            // With the suffix search tree you can only search for one word at a time. Its most efficient to search for the longest word,


NAB

Suggested change

// With the suffix search tree you can only search for one word at a time. Its most efficient to search for the longest word,

// With the suffix search tree, you can only search for one word at a time. It is most efficient to search for the longest word

github-actions · 2024-12-26T20:54:34Z

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

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

github-actions · 2024-12-31T21:51:53Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.79-5 🚀

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

Revert "Revert "Revert "Revert "Search suffix tree implementation""""

e90556d

This reverts commit 20af9f6.

hannojg mentioned this pull request Nov 4, 2024

fix: exclude comma from search values #51393

Closed

48 tasks

hannojg added 5 commits November 4, 2024 15:21

exclude comma from search values

caa7dc5

wip: refactoring test to be reusable

a2d8012

Revert "wip: refactoring test to be reusable"

9ed2253

This reverts commit a2d8012.

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

77d200c

fix: sort search results correctly

a01a375

hannojg mentioned this pull request Nov 5, 2024

[Performance] General performance investigation for opening app from customer profile trace #46595

Open

6 tasks

hannojg marked this pull request as ready for review November 5, 2024 11:01

hannojg requested a review from a team as a code owner November 5, 2024 11:01

melvin-bot bot requested a review from ahmedGaber93 November 5, 2024 11:01

melvin-bot bot removed the request for review from a team November 5, 2024 11:01

hannojg mentioned this pull request Nov 5, 2024

[HOLD for payment 2025-01-07] [Performance] Typing in search is very laggy for big accounts #46591

Open

6 tasks

marcaaron self-requested a review November 5, 2024 21:55

marcaaron assigned hannojg Nov 5, 2024

hannojg added 3 commits November 7, 2024 08:42

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

80d8065

cleanup option list

1e02c82

fix duplicate search results

c73aad5

hannojg mentioned this pull request Nov 7, 2024

perf: cleanup option list #52168

Merged

49 tasks

hannojg added 2 commits November 7, 2024 16:52

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

dd52d6a

eslint

6a7b7e8

wip

253d17b

hannojg mentioned this pull request Nov 8, 2024

clean: moved Category OptionListUtils over to CategoryOptionListUtils #52250

Merged

47 tasks

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

991ea0e

hannojg added 2 commits December 17, 2024 11:55

no default ID for strings

edc0608

add to large files

ddc354f

hannojg added 2 commits December 19, 2024 17:56

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

30b78be

Merge branch 'main' of github.com:Expensify/App into perf/search-tree

e6d69b3

hannojg mentioned this pull request Dec 20, 2024

[HOLD for payment 2025-01-02] [$250] Invite - Two same QA guides in the member list after onboarding with Manage my team's expenses #53579

Closed

8 tasks

fix duplicated personal details Expensify#53579

9755323

This is a more effective implementation for https://github.com/Expensify/App/pull/54147/files which i reverted in this PR

hannojg force-pushed the perf/search-tree branch from 254f263 to 9755323 Compare December 20, 2024 17:24

hannojg added 6 commits December 20, 2024 18:36

add changes from Expensify#54147 back

e90d899

add functionality back to check if current option matches search or not

10d2470

pass filtered options

61f1702

typo

94d5a33

fix up tests

fa3d283

remove debug line

ed3f3d3

ahmedGaber93 approved these changes Dec 21, 2024

View reviewed changes

marcaaron approved these changes Dec 23, 2024

View reviewed changes

marcaaron merged commit bda52b2 into Expensify:main Dec 23, 2024
17 checks passed

Beamanator mentioned this pull request Dec 27, 2024

[$250] Search - No result when searching for current email address and group chat #54594

Open

8 tasks

iwiznia mentioned this pull request Dec 30, 2024

Revert "Search suffix tree implementation" #54666

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search suffix tree implementation #51954

Search suffix tree implementation #51954

hannojg commented Nov 4, 2024 •

edited

Loading

melvin-bot bot commented Nov 5, 2024

hannojg commented Nov 5, 2024 •

edited

Loading

ahmedGaber93 commented Nov 7, 2024 •

edited

Loading

hannojg commented Nov 7, 2024

hannojg commented Nov 7, 2024

ahmedGaber93 commented Nov 8, 2024 •

edited

Loading

hannojg commented Nov 8, 2024 •

edited

Loading

hannojg commented Dec 17, 2024 •

edited

Loading

hannojg commented Dec 17, 2024

ahmedGaber93 commented Dec 17, 2024 •

edited

Loading

ahmedGaber93 commented Dec 17, 2024

hannojg commented Dec 20, 2024

ahmedGaber93 left a comment

marcaaron Dec 23, 2024

marcaaron Dec 23, 2024

github-actions bot commented Dec 26, 2024

github-actions bot commented Dec 31, 2024

	// With the suffix search tree you can only search for one word at a time. Its most efficient to search for the longest word,
	// With the suffix search tree, you can only search for one word at a time. It is most efficient to search for the longest word

Search suffix tree implementation #51954

Search suffix tree implementation #51954

Conversation

hannojg commented Nov 4, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 5, 2024

hannojg commented Nov 5, 2024 • edited Loading

ahmedGaber93 commented Nov 7, 2024 • edited Loading

hannojg commented Nov 7, 2024

hannojg commented Nov 7, 2024

ahmedGaber93 commented Nov 8, 2024 • edited Loading

hannojg commented Nov 8, 2024 • edited Loading

hannojg commented Dec 17, 2024 • edited Loading

hannojg commented Dec 17, 2024

ahmedGaber93 commented Dec 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ahmedGaber93 commented Dec 17, 2024

hannojg commented Dec 20, 2024

ahmedGaber93 left a comment

Choose a reason for hiding this comment

marcaaron Dec 23, 2024

Choose a reason for hiding this comment

marcaaron Dec 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 26, 2024

github-actions bot commented Dec 31, 2024

hannojg commented Nov 4, 2024 •

edited

Loading

hannojg commented Nov 5, 2024 •

edited

Loading

ahmedGaber93 commented Nov 7, 2024 •

edited

Loading

ahmedGaber93 commented Nov 8, 2024 •

edited

Loading

hannojg commented Nov 8, 2024 •

edited

Loading

hannojg commented Dec 17, 2024 •

edited

Loading

ahmedGaber93 commented Dec 17, 2024 •

edited

Loading