cleanup: split filtering & ordering in OptionsListUtils

[hannojg]

Explanation of Change

This PR is a refactoring that clearly splits the responsibilities into:

• filtering options
• ordering options

Before ordering and filtering was happening inter-connectedly, which makes it hard to change anything about that code.

Over at this PR i am working on improving the performance of the filtering:

• https://github.com/Expensify/App/pull/51954

and i need the filtering and ordering to be two clearly separate operations (so we can easily just swap out the filtering for a faster implementation).

Notes about the changes:

• I found that the excludeUnknownUsers was a option that had no code path that was ever used, so I was able to remove it
• Likewise sortPersonalDetailsByAlphaAsc was default true and there was no code path that was setting this to false so I removed that as well
• For ordering the options we need to sort by the lastVisibleActionCreated. It was currently not present on the option and so i added it to createOption
• I renamed getOptions to getValidOptions to emphasis the functions responsibility to return us only the options that are valid for showing in the UI
• I created separate functions for filtering and ordering. The new function to get a filtered and ordered options object is now called filterAndOrderOptions (before it was filterOptions). The new separate functions are:
  • orderReportOptions
  • orderPersonalDetailsOptions
  • orderOptions, combines the two above functions
  • filterReports
  • filterPersonalDetails
  • filterCurrentUserOption
  • filterUserToInvite
  • filterOptions combines the four above

There is also a performance advantage to this I want to point out:

Before we were applying some ordering to all options before filtering them. Now, we filter the options first and then apply the ordering to the remaining search result, which can be way more efficient.

Fixed Issues

$ https://github.com/Expensify/App/pull/51954 PROPOSAL: https://github.com/Expensify/App/pull/51954#issuecomment-2464282215

Tests

• [ ] Verify that no errors appear in the JS console
• [ ] Open the search:
  • Confirm that search results between this branch and production are very much the same (it might be that on dev / production you've different items loaded which can slightly influence the search results, but largely they should match)

Offline tests

QA Steps

Same as testing

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
• [x] 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[hannojg]

cc @ahmedGaber93 since you reviewed all PRs of this cleanup so far 🫶 This is ready for review (will mark it as such once i've filled all the details)

[melvin-bot[bot]]

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

Reviewing and testing today.

[ahmedGaber93]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/abf07695-f61c-48aa-b0ff-7da0f169f898

Android: mWeb Chrome

https://github.com/user-attachments/assets/6e52199d-17f6-42d2-b658-3044aae84c12

iOS: Native

https://github.com/user-attachments/assets/e24903be-719d-477b-996a-36b878fb455a

iOS: mWeb Safari

https://github.com/user-attachments/assets/820ebe88-2f9f-4a32-ad25-769acec3b624

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/295a60ba-18ea-41ab-9223-ddee94c6abb3

https://github.com/user-attachments/assets/d15bcddf-589e-4b62-8b3b-7e2c253369df

https://github.com/user-attachments/assets/c65eabc9-cab0-43ed-ae12-1a170a756099

https://github.com/user-attachments/assets/97e0f450-a921-46b8-9b49-d13a6468e892

https://github.com/user-attachments/assets/10d7edc5-c64f-4698-a4ad-90fbbea2e039

https://github.com/user-attachments/assets/db6305a2-014e-4d6c-a5aa-ef6dad97a80a

https://github.com/user-attachments/assets/9ff74053-e842-46f5-bd24-2a3ce8c3a51f

https://github.com/user-attachments/assets/9df6bf17-2483-4ace-8d05-d5688bb933ed

https://github.com/user-attachments/assets/86e6e6ff-c81b-4b5a-b549-a02585d7192e

MacOS: Desktop

https://github.com/user-attachments/assets/bf730b77-0dee-4f5f-a4ce-f1f9f0bd07ca

[hannojg]

Guys, thank you for the excellent review! 🫶

I have everything applied from the review, but i think there is something broken with the search results. While searching the results between this PR and prod seem the same but when opening the search they look vastly different:

Will mark as ready again once thats fixed

[hannojg]

Okay, prod and dev looked the same now in my test cases:

[neil-marcellini]

Another option is to ask Applause to run the regression tests on this branch, I think we do that sometimes for large changes. I'm not sure it's appropriate for this one, but we can ask if you want to try that.

[ahmedGaber93]

I tested it as much as I could. Search result look the same on dev and staging except the last case

✅ search tab

https://github.com/user-attachments/assets/fd5998ba-6d1d-4103-9ae5-a2faf2b83ff6

✅ search from header icon

https://github.com/user-attachments/assets/308d305e-9d4f-4602-9c6a-bb7b971c48ab

✅ multi search terms

https://github.com/user-attachments/assets/7daa3b39-7a8a-490c-affa-dd7aa02ee6f6

✅ self DM

https://github.com/user-attachments/assets/f106f917-d252-4ed1-86dc-c5665d7cab82

✅ user to join - email

https://github.com/user-attachments/assets/ddaab718-2b83-44a4-9b0b-a09fcbccfd5c

✅ user to join - phone

https://github.com/user-attachments/assets/5172ef82-9f06-4a7c-92ad-94ad60ccf913

✅ start chat

https://github.com/user-attachments/assets/2083438c-8b58-4d66-8f4e-083d4fc7250d

❌ create expense

1. Fresh login with a high traffic account that have a lot of workspaces on DEV and staging
2. Click Fab icon > Create expense > choose participant

The recent reports are not in the same order, especially "Big chat" workspace.

[hannojg]

@ahmedGaber93 Thanks for the thorough testing! Can you please test this case again?

[hannojg]

@neil-marcellini yeah i would sleep better if this PR would get a Applause regression test 😅 maybe we can ask them to only test search features / features that are related to where we show result lists?

[ahmedGaber93]

Can you please test this case again?

Hmm! Ordering still not the same.

[hannojg]

@ahmedGaber93 Okay I think I fixed the ordering now. I did this by separating the order statements, this is how it was working before (ie. the first order function was called in getOptions the second in filterOptions - both functions are now called in the orderReportOptions functions). Would appreciate if you could test this one more time 🙏

I will revisit the ordering function after the cleanup PR is merged. I think sorting twice is quite inefficient and especially lodash orderBy is known to be slow (but will profile soon and provide before and after values!)

[melvin-bot[bot]]

🎯 @ahmedGaber93, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: https://github.com/Expensify/App/issues/53857.

[OSBotify]

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

[github-actions[bot]]

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

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

[github-actions[bot]]

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.75-6 🚀

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