Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: dropdown title does not follow search name #49446

Merged
merged 8 commits into from
Sep 26, 2024

Conversation

dominictb
Copy link
Contributor

@dominictb dominictb commented Sep 19, 2024

Details

Fixed Issues

$ #49208
PROPOSAL: #49208 (comment)

Tests

1. Test case 1: Small screen device:

Precondition: User has saved a few searches.

  1. Go to staging.new.expensify.com
  2. Go to Search.
  3. Tap on the dropdown.
  4. Open any saved search. Verify the dropdown title should follow the name of the search.
  5. Tap on the dropdown. Verify when viewing a saved search, there should not be "type:expense" tab in the dropdown list.

2. Test case 2: Small screen device:

Precondition: User has saved a few searches.

  1. Go to staging.new.expensify.com
  2. Go to Search.
  3. Tap on the dropdown.
  4. Click three dots on any option > Rename > Enter a new name > Save.
  5. Verify the dropdown title should follow the new name.

3. Test case 3: Large screen device:

Precondition: User has saved a few searches.

  1. Go to staging.new.expensify.com
  2. Go to Search.
  3. Open any saved search. Verify it works properly as it is because these changes only apply to small screen.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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-19.at.16.17.26.mov
Android: mWeb Chrome
Screen.Recording.2024-09-19.at.16.19.06.mov
iOS: Native
Screen.Recording.2024-09-19.at.16.20.12.mov
iOS: mWeb Safari
Screen.Recording.2024-09-19.at.16.14.09.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-19.at.16.04.28.mov
MacOS: Desktop
Screen.Recording.2024-09-19.at.16.21.02.mov

@dominictb dominictb marked this pull request as ready for review September 19, 2024 09:29
@dominictb dominictb requested a review from a team as a code owner September 19, 2024 09:29
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team September 19, 2024 09:29
Copy link

melvin-bot bot commented Sep 19, 2024

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

@brunovjk
Copy link
Contributor

When renaming, the field is always empty, is this a bug already reported? Thanks.

Screen.Recording.2024-09-19.at.09.23.39.mov

@dominictb @lakchote

@lakchote
Copy link
Contributor

When renaming, the field is always empty, is this a bug already reported? Thanks.

@dominictb @lakchote

This is not a bug. This is what was shown in the design template, however there's discussion around it to include it.

There's an issue for that.

@brunovjk
Copy link
Contributor

When renaming, the field is always empty, is this a bug already reported? Thanks.
@dominictb @lakchote

This is not a bug. This is what was shown in the design template, however there's discussion around it to include it.

There's an issue for that.

Thanks for clarifying, I will continue with the checklist.

@brunovjk
Copy link
Contributor

brunovjk commented Sep 19, 2024

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
49446_android_native.mov
Android: mWeb Chrome
49446_android_web.mov
iOS: Native
49446_ios_native.mov
iOS: mWeb Safari
49446_ios_web.mov
MacOS: Chrome / Safari
49446_web_browser.mov
MacOS: Desktop
49446_web_desktop.mov

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

Looking good to me :D

@lakchote
Copy link
Contributor

Tap on the dropdown. Verify when viewing a saved search, there should not be "type:expense" tab in the dropdown list.

This condition is falsy in your iOS test @brunovjk

@brunovjk
Copy link
Contributor

brunovjk commented Sep 19, 2024

Tap on the dropdown. Verify when viewing a saved search, there should not be "type:expense" tab in the dropdown list.

This condition is falsy in your iOS test @brunovjk

Hi @lakchote, thanks for your feedback. You are right. I first assumed the focus of this PR was maintaining consistency of saved search names. But indeed, I think we can update getSearchHeaderTitle to avoid always returning type:... status :...:

App/src/libs/SearchUtils.ts

Lines 748 to 758 in 33debc8

function getSearchHeaderTitle(
queryJSON: SearchQueryJSON,
PersonalDetails: OnyxTypes.PersonalDetailsList,
cardList: OnyxTypes.CardList,
reports: OnyxCollection<OnyxTypes.Report>,
TaxRates: Record<string, string[]>,
) {
const {type, status} = queryJSON;
const filters = queryJSON.flatFilters ?? {};
let title = `type:${type} status:${status}`;

cc: @dominictb @luacmartins

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Code is looking good. I think we should also just remove the custom menu item, if we're viewing a saved search. cc @Expensify/design

Screenshot 2024-09-20 at 8 27 10 AM

@shawnborton
Copy link
Contributor

Agree with that. Also, shouldn't the saved searches have a bookmark icon?

@luacmartins
Copy link
Contributor

Yes, that was reported in another issue

@lakchote
Copy link
Contributor

@dominictb can you modify your PR to address the recent comments?

@luacmartins
Copy link
Contributor

@dominictb bump on the comments above

@dominictb
Copy link
Contributor Author

I am working on it. Is it the expected behavior?

Screenshot 2024-09-23 at 10 59 47

@luacmartins
Copy link
Contributor

@dominictb we should remove the canned query entry from the dropdown
Screenshot 2024-09-23 at 1 23 02 PM

@dominictb
Copy link
Contributor Author

@luacmartins In case the filter we are viewing is not saved, should we remove it from dropdown menu?

@luacmartins
Copy link
Contributor

No, we should only remove it when viewing a saved search

@dominictb
Copy link
Contributor Author

@brunovjk I updated PR to match this comment:

Screen.Recording.2024-09-23.at.12.32.28.mov

@brunovjk
Copy link
Contributor

Thanks for the changes @dominictb, looking good so far:

Screen.Recording.2024-09-23.at.11.37.24.mov

Did you have a chance to look at these: comment 1 comment 2?
What do you think? Thanks.

@lakchote
Copy link
Contributor

cc @dominictb

friendly bump for @brunovjk's comment here

@dominictb
Copy link
Contributor Author

This condition is falsy in your iOS test @brunovjk

@brunovjk Sorry, but I noticed that in all your iOS videos in the checklist, it works fine.

I think we can update getSearchHeaderTitle to avoid always returning type:... status

@brunovjk Can you share your solution? IMO, I think with the search that does not have a custom name, using "type:...status" format is fine.

@lakchote
Copy link
Contributor

This condition is falsy in your iOS test @brunovjk

@brunovjk Sorry, but I noticed that in all your iOS videos in the checklist, it works fine.

I think we can update getSearchHeaderTitle to avoid always returning type:... status

@brunovjk Can you share your solution? IMO, I think with the search that does not have a custom name, using "type:...status" format is fine.

cc @brunovjk in case you've missed this

@brunovjk

This comment was marked as outdated.

@brunovjk
Copy link
Contributor

brunovjk commented Sep 25, 2024

Details

Fixed Issues

$ #49208 PROPOSAL: #49208 (comment)

Tests

1. Test case 1: Small screen device:

Precondition: User has saved a few searches.

  1. Go to staging.new.expensify.com
  2. Go to Search.
  3. Tap on the dropdown.
  4. Open any saved search. Verify the dropdown title should follow the name of the search.
  5. Tap on the dropdown. Verify when viewing a saved search, there should not be "type:expense" tab in the dropdown

I believe what @lakchote meant here @dominictb is that we are failing in the step above this PR itself.

What I tested here was "Verify the dropdown title should follow the name of the search" and "remove the canned query entry from the dropdown". However, there is still one missing point in the Expected Result of the issue:

In Step 5, when viewing a saved search, there should not be "type:expense" tab in the dropdown list.

I believe the expected name when we create a "search" is something like the videos of this PR, without type:... status:...by default. @lakchote and @luacmartins what do you think? Does that make sense? Thank you very much.

@luacmartins
Copy link
Contributor

I believe the expected name when we create a "search" is something like the videos of this #48566, without type:... status:...by default. @lakchote and @luacmartins what do you think? Does that make sense? Thank you very much.

I think these two should match and IMO it seems valuable to leave the type and status there, especially for saved searches since that could be saved for any type/status

Screenshot 2024-09-26 at 9 38 14 AM

@dominictb
Copy link
Contributor Author

I believe what @lakchote meant #49446 (comment) @dominictb is that we are failing in the step above this PR itself.

@lakchote Can you give me more detail, on what is failing there since you mentioned "This condition is falsy in your iOS test @brunovjk"

@lakchote
Copy link
Contributor

I believe what @lakchote meant #49446 (comment) @dominictb is that we are failing in the step above this PR itself.

@lakchote Can you give me more detail, on what is failing there since you mentioned "This condition is falsy in your iOS test @brunovjk"

There seems to be confusion on what was expected.

The problem I was referring (which @luacmartins talked about too here) was solved already by @dominictb.

When viewing a saved search, we should not see in the dropdown the original query of the saved search, we should hide it.

We should not try to hide specificallytype:... status :.. (for the reasons mentioned here), as such @dominictb's PR seems to be looking good to me.

cc @brunovjk

@brunovjk
Copy link
Contributor

brunovjk commented Sep 26, 2024

I see now, yes I did the confusion, sorry, thanks for clarifying @lakchote, I will retest and update Screenshots/Videos now.

@brunovjk
Copy link
Contributor

LGTM, all yours @luacmartins.

@luacmartins luacmartins merged commit 4684d9a into Expensify:main Sep 26, 2024
16 checks passed
@OSBotify
Copy link
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.

Copy link
Contributor

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

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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

@@ -28,6 +28,7 @@ function SearchPageBottomTab() {
const [selectionMode] = useOnyx(ONYXKEYS.MOBILE_SELECTION_MODE);
const searchParams = activeCentralPaneRoute?.params as AuthScreensParamList[typeof SCREENS.SEARCH.CENTRAL_PANE];
const parsedQuery = SearchUtils.buildSearchQueryJSON(searchParams?.q);
const searchName = searchParams?.name;
Copy link
Contributor

Choose a reason for hiding this comment

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

This change misses covering the case where the search name equals the query name which introduce this issue so we should get searchName based on search query

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.

7 participants