Skip to content

Suggested Search - #62851

Merged
luacmartins merged 39 commits into
mainfrom
jsenyitko-suggested-search
May 30, 2025
Merged

luacmartins merged 39 commits into
mainfrom
jsenyitko-suggested-search

Conversation

@JS00001

@JS00001 JS00001 commented May 27, 2025 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Implemented suggested search! See below for the expected behavior.

Fixed Issues

$ #61112
$ #61114
$ #61116
$ #61117
$ #61189

Tests

Test all variations of search. The following are supposed to be in the LHN:
Expenses, Reports, Chats: Always in LHN
'Submit' - Only in LHN when user is in a workspace
'Approve' - Only when a user is the policys 'approver', OR the user is the 'submitsTo' value for another user
'Pay' - Only when the user is a workspace admin
'Export' - Only when the user is an exporter for one of the accounting integrations

Ensure that all expected results show up, ensure that all new 'filter dropdowns' show the expected behavior and behave as expected, ensure that the new 'Filters' button works & has the expected behavior

Similarly, the following should be tested and verified to be working/not broken or buggy:

  • Opening the 'From' dropdown in search on mobile, including native, safari, and chrome. This should especially be verified when focusing the search input. Test with no users, a bunch of users to search, selecting users, unselecting users, filtering users down to a smaller list, etc.
  • Ensure when the keyboard is visible in the 'From' dropdown, that you can still select a user and keep the keyboard open.
  • Ensure that when theres a lot of thing selected in the filter chips, that the caret never overflows on native mobile.
  • Ensure the 'From' dropdown includes your own email
  • Ensure that when we follow the following steps are taken: Search > Submit (Suggested search item) > Change 'Type' to 'Chat', that 'group-by:reports' gets cleared
  • Ensure that when using 'group-by:reports', the 'unreported' status does not show in the dropdown
  • Ensure that Searches 'clear' button is not visible when there is no text visible in the searchbar
  • Ensure that typing random strings like ajnsdjkaskj and then clicking the 'clear' button actually clears the input
  • Ensure that when saving a suggested search as a saved search, that only one is highlighted at a time. The saved search should take priority to be highlighted.
  • Verify that no errors appear in the JS console

QA Steps

Same as Tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 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).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • 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)
  • I followed proper code patterns (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
      • 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:
    • 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 followed the guidelines as stated in the Review Guidelines
  • 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)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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 verified that similar component doesn't exist in the codebase
  • I verified that all props are defined accurately and each prop has a /** comment above it */
  • I verified that each file is named correctly
  • I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • I verified that the only data being stored in component state is data necessary for rendering and nothing else
  • In component if we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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)
  • I verified that component 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)
  • I verified that all JSX used for rendering exists in the render method
  • I verified that each 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

Screenshots/Videos

Android: Native
iOS: Native
Screen.Recording.2025-05-09.at.11.59.29.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-05-09.at.11.42.49.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-05-09.at.11.35.58.AM.mov

@melvin-bot

melvin-bot Bot commented May 27, 2025

Copy link
Copy Markdown

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@JS00001 JS00001 self-assigned this May 27, 2025
@JS00001
JS00001 marked this pull request as ready for review May 27, 2025 18:55
@JS00001
JS00001 requested review from a team as code owners May 27, 2025 18:55
@melvin-bot
melvin-bot Bot requested review from ZhenjaHorbach and removed request for a team May 27, 2025 18:55
@melvin-bot

melvin-bot Bot commented May 27, 2025

Copy link
Copy Markdown

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

@JS00001
JS00001 requested review from getusha and luacmartins and removed request for ZhenjaHorbach May 27, 2025 18:55
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @JS00001 has triggered a test app build. You can view the workflow run here.

@github-actions

This comment has been minimized.

@dubielzyk-expensify

Copy link
Copy Markdown
Contributor

Wow this is very exciting 😄

I'll get started on some, but I'm sure @Expensify/design will find other things.

The mobile menu has one of the section headlines in bold (it should be regular and this doesn't happen on desktop):

CleanShot 2025-05-28 at 14 31 00@2x

@luacmartins
luacmartins merged commit 8e725d5 into main May 30, 2025
@luacmartins
luacmartins deleted the jsenyitko-suggested-search branch May 30, 2025 17:54
@OSBotify

Copy link
Copy Markdown
Contributor

✋ 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

github-actions Bot commented Jun 2, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.55-0 🚀

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

@marcaaron

Copy link
Copy Markdown
Contributor

I suspect this PR caused the Deploy Blocker assigned to me here (it has an Hourly label applied).

I think the problem could be this part. Maybe we are not filtering out the personal policy?

Though, I also see that is also gated behind a canUseTableReportView so maybe it's behind a beta? I have no idea and neither does QA.

@nkuoch

nkuoch commented Jun 3, 2025

Copy link
Copy Markdown
Contributor

@JS00001 can this be the cause of this bug?

@github-actions

github-actions Bot commented Jun 3, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.56-2 🚀

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

@github-actions

github-actions Bot commented Jun 3, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.58-0 🚀

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

@github-actions

github-actions Bot commented Jun 4, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.1.58-4 🚀

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

Comment on lines +66 to +79
// Get a list of all options/personal details and filter them by the current search term
const listData = useMemo(() => {
const optionsList = getValidOptions(
{
reports: options.reports,
personalDetails: options.personalDetails,
},
{
selectedOptions,
excludeLogins: CONST.EXPENSIFY_EMAILS_OBJECT,
includeSelectedOptions: true,
includeCurrentUser: true,
},
);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the time of write. This caused an inconsistency with the from RHP filter SearchFiltersParticipantsSelector.

  • SearchFiltersParticipantsSelector: The current user option was obtained separately via currentUserOption returned from OptionsListUtils.filterAndOrderOptions
  • UserSelectPopup: The current user option was obtained from the returned personal details list (just like any other account).

The former had extra search terms (you) so you could find your account easily however the later didn't and searching for you didn't return the expected results.


FWIW, now we are using the personal details to return the current user option and added the missing search terms here #67071

Coming from #63856

<SelectionList
canSelectMultiple
textInputAutoFocus={false}
shouldClearInputOnSelect={false}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Selecting search result should have cleared the input: #63575

const filterFormValuesKey = JSON.stringify(filterFormValues);

const openAdvancedFilters = useCallback(() => {
updateAdvancedFilters(filterFormValues);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #68127, we should use

Onyx.set(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM, values); here to reset all data

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.