[Search v2.3] Fix tooltip rendering #49473

lakchote · 2024-09-19T14:52:44Z

Details

Video test:

Screen.Recording.2024-09-20.at.11.17.59.mov

Fixed Issues

$ #49204

Tests

Verify that no errors appear in the JS console

Go to the Search page
Create a saved search
Verify the tooltip is showing
Log out
Go to the search page again
The tooltip should not show again

Offline tests

QA Steps

Verify that no errors appear in the JS console

Same as in tests

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2024-09-19T22:57:59Z

PR is looking good. Let me know once it's ready for review

lakchote · 2024-09-20T09:23:17Z

PR is looking good. Let me know once it's ready for review

Ready for review!

melvin-bot · 2024-09-20T09:23:24Z

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

paultsimura · 2024-09-20T09:54:07Z

Hi, does it need a c+ review?

lakchote · 2024-09-20T11:47:07Z

Hi, does it need a c+ review?

Yes, please

paultsimura · 2024-09-20T12:14:18Z

Cool, will do within the next hour👍

paultsimura · 2024-09-20T13:16:15Z

@lakchote is the BE PR already on staging/prod?

paultsimura · 2024-09-20T13:33:58Z

Bug:

Have multiple saved searches
Re-login (and clear the site data)
Go to the saved searches page
Resize the page
Notice the SearchTypeMenu.item.renderTooltipContent is called numerous times, which results in calling the API even if the tooltip is not shown.

2024-09-20.-.15.31.-.Screen.Recording.2024-09-20.at.15.30.16.mp4

paultsimura · 2024-09-20T13:46:28Z

I guess the offending PR for this is #44277. Added a comment there to get some 👀 of the author and C+.

src/pages/Search/SearchTypeMenu.tsx

lakchote · 2024-09-20T14:29:17Z

@lakchote is the BE PR already on staging/prod?

Sorry, when I meant it was available to review I was speaking of the code, not necessarily the whole flow. More of like a pre-review, if you would.

The BE PR is still pending review, so you won't be able to test the whole flow yet.

lakchote · 2024-09-20T14:31:18Z

I guess the offending PR for this is #44277. Added a comment there to get some 👀 of the author and C+.

Very nice find. It's important to correct this as it does a boatload of unnecessary API calls. cc @luacmartins

luacmartins

I'm discussing this 1:1 with Lucien, but I think we can probably find a frontend only approach to solve this issue. I think we could rely solely on the length of the savedSearches NVP

src/ONYXKEYS.ts

Co-authored-by: Carlos Martins <cmartins@expensify.com>

luacmartins

LGTM

paultsimura · 2024-09-23T09:42:11Z

Reviewing now.

paultsimura

Small typo

src/ONYXKEYS.ts

paultsimura · 2024-09-23T10:22:33Z

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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

2024-09-23.-.12.04.-.Screen.Recording.2024-09-23.at.11.51.44.mp4

MacOS: Desktop

2024-09-23.-.12.04.-.Screen.Recording.2024-09-23.at.12.01.58.mp4

paultsimura · 2024-09-23T10:22:59Z

@lakchote this tests well, there's just one typo fix and we're good to go.

src/pages/Search/AdvancedSearchFilters.tsx

lakchote · 2024-09-23T13:12:59Z

@lakchote this tests well, there's just one typo fix and we're good to go.

Updated code!

paultsimura

LGTM ✔️

melvin-bot · 2024-09-23T13:32:24Z

@mjasikowski 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

luacmartins · 2024-09-24T00:42:50Z

Unrelated JEST tests are failing. I tried to merge main, but it seems broken there too.

luacmartins · 2024-09-24T00:43:03Z

Gonna wait for a fix so we can merge this

paultsimura · 2024-09-24T07:05:37Z

@lakchote seems like the unit test got fixed on main, please merge

OSBotify · 2024-09-24T08:11:33Z

✋ 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 · 2024-09-24T19:30:29Z

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

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

github-actions · 2024-09-27T17:45:24Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.40-6 🚀

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

lakchote added 2 commits September 19, 2024 16:50

persist in the backend the nvp value

e59a7a8

fix tooltip rendering logic

d9d574d

lakchote requested a review from luacmartins September 19, 2024 14:52

lakchote self-assigned this Sep 19, 2024

lakchote changed the title ~~[Search v2.3] Fix tooltip rendering~~ [HOLD Auth #12548] [Search v2.3] Fix tooltip rendering Sep 20, 2024

lakchote marked this pull request as ready for review September 20, 2024 09:23

lakchote requested a review from a team as a code owner September 20, 2024 09:23

melvin-bot bot requested review from paultsimura and removed request for a team September 20, 2024 09:23

lakchote force-pushed the lucien/fix-tooltip-saved-searches branch from 9a1f267 to d9d574d Compare September 20, 2024 11:46

paultsimura mentioned this pull request Sep 20, 2024

Feature: Tooltip for GBR #44277

Merged

50 tasks

paultsimura reviewed Sep 20, 2024

View reviewed changes

src/pages/Search/SearchTypeMenu.tsx Outdated Show resolved Hide resolved

remove check

87989ce

luacmartins reviewed Sep 22, 2024

View reviewed changes

lakchote added 4 commits September 23, 2024 07:58

use better naming for NVP

f703a8c

add method for saved search NVP tooltip rendering

8e27005

use new name for NVP

4523eaa

set the nvp for the tooltip if no saved searches present

77e9333

lakchote changed the title ~~[HOLD Auth #12548] [Search v2.3] Fix tooltip rendering~~ [Search v2.3] Fix tooltip rendering Sep 23, 2024

luacmartins requested changes Sep 23, 2024

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

Update ONYXKEYS.ts

c93f037

Co-authored-by: Carlos Martins <cmartins@expensify.com>

luacmartins previously approved these changes Sep 23, 2024

View reviewed changes

paultsimura suggested changes Sep 23, 2024

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

paultsimura reviewed Sep 23, 2024

View reviewed changes

src/pages/Search/AdvancedSearchFilters.tsx Outdated Show resolved Hide resolved

lakchote added 2 commits September 23, 2024 15:10

fix typo

cf3c645

safely check saved searches

7219783

lakchote dismissed luacmartins’s stale review via 7219783 September 23, 2024 13:10

paultsimura approved these changes Sep 23, 2024

View reviewed changes

melvin-bot bot requested a review from mjasikowski September 23, 2024 13:32

luacmartins approved these changes Sep 23, 2024

View reviewed changes

Merge branch 'main' into lucien/fix-tooltip-saved-searches

906b701

Merge branch 'main' into lucien/fix-tooltip-saved-searches

6a1fc0a

luacmartins merged commit 1c39bd2 into main Sep 24, 2024
16 checks passed

luacmartins deleted the lucien/fix-tooltip-saved-searches branch September 24, 2024 08:00

github-actions bot mentioned this pull request Sep 24, 2024

Deploy Checklist: New Expensify 2024-09-24 #49662

Closed

67 tasks

paultsimura mentioned this pull request Sep 27, 2024

[Search v2.3] - Educational tooltip appears repeatedly after relogin #49204

Closed

6 tasks

paultsimura mentioned this pull request Oct 7, 2024

[Search v2.3] [App] Implement Saved Search feature #48566

Merged

71 tasks

izarutskaya mentioned this pull request Oct 29, 2024

Search - Tooltip is not displayed on the new Saved search indicating the name can be edited #51531

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v2.3] Fix tooltip rendering #49473

[Search v2.3] Fix tooltip rendering #49473

lakchote commented Sep 19, 2024 •

edited

Loading

luacmartins commented Sep 19, 2024

lakchote commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

paultsimura commented Sep 20, 2024

lakchote commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024 •

edited

Loading

lakchote commented Sep 20, 2024

lakchote commented Sep 20, 2024 •

edited

Loading

luacmartins left a comment

luacmartins left a comment

paultsimura commented Sep 23, 2024

paultsimura left a comment

paultsimura commented Sep 23, 2024

paultsimura commented Sep 23, 2024

lakchote commented Sep 23, 2024

paultsimura left a comment

melvin-bot bot commented Sep 23, 2024

luacmartins left a comment

luacmartins commented Sep 24, 2024

luacmartins commented Sep 24, 2024

paultsimura commented Sep 24, 2024

OSBotify commented Sep 24, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

[Search v2.3] Fix tooltip rendering #49473

[Search v2.3] Fix tooltip rendering #49473

Conversation

lakchote commented Sep 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

luacmartins commented Sep 19, 2024

lakchote commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

paultsimura commented Sep 20, 2024

lakchote commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024

paultsimura commented Sep 20, 2024 • edited Loading

lakchote commented Sep 20, 2024

lakchote commented Sep 20, 2024 • edited Loading

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

paultsimura commented Sep 23, 2024

paultsimura left a comment

Choose a reason for hiding this comment

paultsimura commented Sep 23, 2024

Reviewer Checklist

Screenshots/Videos

paultsimura commented Sep 23, 2024

lakchote commented Sep 23, 2024

paultsimura left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 23, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 24, 2024

luacmartins commented Sep 24, 2024

paultsimura commented Sep 24, 2024

OSBotify commented Sep 24, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

lakchote commented Sep 19, 2024 •

edited

Loading

paultsimura commented Sep 20, 2024 •

edited

Loading

lakchote commented Sep 20, 2024 •

edited

Loading