Search Results Page Header Cleanup

[289Adam289]

Details

Cleanup od Search Page Header. Replace IDs by actual names. Cleanup SearchUtils file.

Fixed Issues

$ #47254
$ #48483
PROPOSAL:

Tests

1. Open the app
2. Go to Search
3. From the available options, select both a Type (Expense, Invoice, Trip, or Chat) and a Status (from the status bar).
4. Click "Filters" button
5. use different filters(focus on In, Card, TaxRate, From, To)
6. Click "View results"
7. Verify that Search Page Header is correct

• Verify that no errors appear in the JS console

Offline tests

QA Steps

same steps as Test

• 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 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
• 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

Screen.Recording.2024-09-06.at.13.36.07.mp4

Android: mWeb Chrome

Screen.Recording.2024-09-06.at.13.38.05.mp4

iOS: Native

Screen.Recording.2024-09-06.at.13.27.35.mp4

iOS: mWeb Safari

Screen.Recording.2024-09-06.at.13.30.42.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-09-06.at.12.55.27.mp4

MacOS: Desktop

[Kicu]

LGTM, I don't think there is enough duplication to warrant for any code extraction. This looks good as is.

I have a feeling this PageHeader will be becoming more and more complex in future, so not worth it to refactor it heavily today

[Kicu]

LGTM 👍

[melvin-bot]

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

[luacmartins]

LGTM

[rayane-d]

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

Screen.Recording.2024-09-11.at.4.45.33.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-11.at.4.42.33.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-11.at.16.41.55.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-11.at.16.39.55.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-09-11.at.4.28.17.PM.mov

Screen.Recording.2024-09-11.at.4.29.06.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-11.at.4.40.41.PM.mov

[289Adam289]

@rayane-djouah friendly bump

[luacmartins]

Let's get this one to the finish line!

[rayane-d]

@Expensify/design, we've removed the type:${type} status:${status} section from the header title due to the contextual filters already in place. While the selected status is visible through the status bar on both desktop and mobile, the selected type is not clearly displayed to the user:

1. On Desktop: The selected type isn't highlighted in the LHN on the result page.

Video

Screen.Recording.2024-09-10.at.10.48.52.AM.mov

2. On Mobile: The search query displayed on the dropdown button omits the type

Video

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-10.at.10.51.33.mp4

What do you think? How can we make the selected type clearly displayed on the search result page?

[Kicu]

Good catch @rayane-djouah

I think the current state we landed in is because originally the plan was to have both Status and Type in the contextual tabs at top like in here:

However over the course of implementing this we forgot about it.
LHN menu in this case would simply be a list of buttons with "shortcuts" to pre-defined searches, and would only be highlighted if the specific search is a matching "canned" search. As soon as Advanced filters are added to query, LHN is not highlighted in any way.

That being said I saw somewhere on slack threads where the designers were reconsidering what should be displayed on LHN and what on the tabs.
I guess we need to wait on @luacmartins hear his opinion whether we should add the "type bar".

[shawnborton]

Hmm shouldn't the type automatically be prepended in the query here? This is what happens when you simply filter on a Merchant on the expenses page for instance:

So I would expect to see type:invoice in your example above.

[luacmartins]

@shawnborton I think this PR is removing the type/status from the header so it's not shown anymore. That being said, we'll get rid of this header pretty soon, so I don't think we should spend a ton of time on it and maybe we just leave it as is for now with the type/status in it.

[shawnborton]

and maybe we just leave it as is for now with the type/status in it.

Ah yes but the whole point is that the type is not being added to the header for things like invoices. I am saying we should add type:invoice to the query so it's clear what kind of expenses you are viewing.

[Kicu]

@shawnborton @luacmartins are we still adding the bar with types, like in old screenshots and in Figma?
like here:

[rayane-d]

@shawnborton Do we need to add both type:${type} and status:${status} or type:${type} only since the selected status is visible through the status bar?

[shawnborton]

are we still adding the bar with types, like in old screenshots and in Figma? like here:

I think that is the plan for custom searches at least.

Do we need to add both type:${type} and status:${status} or type:${type} only since the selected status is visible through the status bar?

Good question. I think the answer is yes? The tab bar and status bar are kind of like helpers that help you build the query, but I think we still want to show the query in the search input. Is that your understanding too @luacmartins ?

[luacmartins]

Yes, I think we should show both type and status on the header for now. @Kicu yes, we're still replacing the header with the search and type bars

[rayane-d]

Changes look good to me and test well. The reviewer checklist is also complete.

[luacmartins]

LGTM

[OSBotify]

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.33-4 🚀

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