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

Add canned searches #42184

Merged
merged 18 commits into from
Jun 3, 2024
Merged

Conversation

jnowakow
Copy link
Contributor

@jnowakow jnowakow commented May 15, 2024

Details

Fixed Issues

$ #41625
PROPOSAL: N/A

Tests

  1. Go to Search Page, Profile > Troubleshoot > New search page
  2. There should be 4 options to pick
  3. Only Expenses option works because other are not implemented on backend.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as in 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 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
android.mov
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
Desktop.mov

@jnowakow jnowakow requested a review from a team as a code owner May 15, 2024 09:24
@jnowakow jnowakow marked this pull request as draft May 15, 2024 09:25
@melvin-bot melvin-bot bot removed the request for review from a team May 15, 2024 09:25
Copy link

melvin-bot bot commented May 15, 2024

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

@melvin-bot melvin-bot bot requested a review from nkuoch May 15, 2024 09:25
@luacmartins luacmartins self-requested a review May 15, 2024 12:18
Copy link
Contributor

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

Hey this is pretty straightforward and everything looks good to me.

Can you confirm in devtools > Network that after clicking on a different tab the /search api call is sent with a different and correct query param? (just drop a screenshot)

@jnowakow
Copy link
Contributor Author

Can you confirm in devtools > Network that after clicking on a different tab the /search api call is sent with a different and correct query param? (just drop a screenshot)

@Kicu yup, I believe it works as expected:

image
image
image

@jnowakow jnowakow marked this pull request as ready for review May 22, 2024 06:25
@jnowakow jnowakow requested a review from a team as a code owner May 22, 2024 06:25
@shawnborton
Copy link
Contributor

The screenshots look cool, but just wondering how we want to handle this UI in light of Search v2? Thoughts @Expensify/design @JmillsExpensify @luacmartins? Should we be making these as tabs across the top of the content pane view?

@dannymcclain
Copy link
Contributor

Oh boy, yeah I think we should 😬

@dubielzyk-expensify
Copy link
Contributor

Yeah, that probably makes sense.

@luacmartins
Copy link
Contributor

Discussed this with @trjExpensify and @JmillsExpensify but I think we still want to push forward as is, since we're still months out on Search v2 and adding these items to the LHN would allow us to test things in the meantime without the LHN looking really empty and weird. Additionally, we still need to design the tab bar and how its filtering capabilities would work, so this is a good stepping stone in the meantime.

@JmillsExpensify
Copy link

JmillsExpensify commented May 23, 2024

Yes agreed. I can see both perspectives, but if we move the type filter to the LHN, then it'll basically remain Expenses for months, as we aren't bringing other types in the LHN until later phases of the Search v2 implementation, which hasn't yet begun.

@shawnborton
Copy link
Contributor

Okay cool, that works for me then.

Copy link
Contributor

@shawnborton
Copy link
Contributor

Looks good to me, confirming that changing the canned search doesn't actually load results except for the first item of Expenses, right?

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.

LGTM

src/pages/Search/SearchPage.tsx Outdated Show resolved Hide resolved
@parasharrajat
Copy link
Member

parasharrajat commented May 28, 2024

I see a very different UI for search. Am I missing a step?

Screen.Recording.2024-05-29.at.1.41.54.AM.mov

@luacmartins
Copy link
Contributor

@parasharrajat this is for the new search page. You can access it via Profile > Troubleshoot > New search page

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

Screen.Recording.2024-05-29.at.1.51.45.AM.mov

🔲 iOS / Safari

Screen.Recording.2024-05-29.at.1.53.14.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-05-29.at.1.54.36.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-05-29.at.1.48.42.AM.mov

🔲 Android / Chrome

Screen.Recording.2024-05-29.at.1.51.15.AM.mov

🔲 Android / native

Screen.Recording.2024-05-29.at.1.55.08.AM.mov

@parasharrajat
Copy link
Member

@jnowakow Did you replace the icons with the latest shared ones?

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 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 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 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 have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from luacmartins May 28, 2024 20:27
@parasharrajat
Copy link
Member

One comment #42184 (comment).

I will review it again when HOLD is removed.

@@ -324,6 +324,9 @@ export default {
action: 'Acción',
expenses: 'Gastos',
tax: 'Impuesto',
shared: 'Compartido',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
shared: 'Compartido',
shared: 'Compartidos',

Copy link
Contributor

Choose a reason for hiding this comment

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

Bump @jnowakow. I think we should change this to plural since all other ones are plural too

@@ -324,6 +324,9 @@ export default {
action: 'Acción',
expenses: 'Gastos',
tax: 'Impuesto',
shared: 'Compartido',
drafts: 'Borradores',
finished: 'Finalizado',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
finished: 'Finalizado',
finished: 'Finalizados',

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Haha I asked for another translation and got the plural like I suggested above. I think it makes sense to use the plural, since all other items are plural too, e.g. Expenses, Drafts

Copy link
Contributor

Choose a reason for hiding this comment

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

Bump @jnowakow. I think we should change this to plural since all other ones are plural too

@jnowakow
Copy link
Contributor Author

jnowakow commented May 29, 2024

@jnowakow Did you replace the icons with the latest shared ones?

@parasharrajat simple-ilustration__sendmoney is still the one that I exported (see here)

@parasharrajat
Copy link
Member

Shouldn't the edge gap be removed from the checkmark icon like other icons? @Expensify/design
Screenshot 2024-05-29 at 2 42 36 PM

@shawnborton
Copy link
Contributor

I think that one is fine as-is, that's how we have it in our system at least.

@shawnborton
Copy link
Contributor

We can make it fill up more space if anyone feels strongly though. Thoughts @Expensify/design ?

@dubielzyk-expensify
Copy link
Contributor

Unless it looks really odd in product, I think it's fine as is 👍

Our icons and colored illustrations use very different spacing by design :)

@luacmartins luacmartins self-requested a review June 3, 2024 16:23
@@ -324,6 +324,9 @@ export default {
action: 'Acción',
expenses: 'Gastos',
tax: 'Impuesto',
shared: 'Compartido',
Copy link
Contributor

Choose a reason for hiding this comment

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

Bump @jnowakow. I think we should change this to plural since all other ones are plural too

@@ -324,6 +324,9 @@ export default {
action: 'Acción',
expenses: 'Gastos',
tax: 'Impuesto',
shared: 'Compartido',
drafts: 'Borradores',
finished: 'Finalizado',
Copy link
Contributor

Choose a reason for hiding this comment

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

Bump @jnowakow. I think we should change this to plural since all other ones are plural too

@luacmartins luacmartins changed the title [HOLD API implementation] Add canned searches Add canned searches Jun 3, 2024
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.

I'm gonna merge this PR to help test the other queries.

@luacmartins luacmartins merged commit f8ff83e into Expensify:main Jun 3, 2024
20 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 3, 2024

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

@lanitochka17
Copy link

This PR is failing because of issue #43051

The issue is reproducible in: All environments

Bug6501851_1717522666977.video_24.mp4

@Kicu
Copy link
Contributor

Kicu commented Jun 5, 2024

Verified that this is not a problem, as the rest of tabs was explicitly disabled by us here: #43016

@luacmartins
Copy link
Contributor

Agree with the comment above

@OSBotify
Copy link
Contributor

OSBotify commented Jun 6, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

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

Successfully merging this pull request may close these issues.

10 participants