Support empty value for categories and tags #50122

luacmartins · 2024-10-02T23:59:40Z

Details

Adds support to select expenses without any category or tag

Fixed Issues

$ #49675

Tests

Test with this API branch

Pre-requisite: expenses with and without categories/tags

Navigate to the Search page
Open the filters and select No category
Verify that the results only include expenses without categories
Select multiple categories, including No category
Verify that the results include expenses without category OR expenses with the selected categories
Repeat 2-5 for the tags filters

Verify that no errors appear in the JS console

Offline tests

N/A

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

Screen.Recording.2024-10-10.at.5.38.48.PM.mov

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-10-10T23:39:58Z

@ikevin127 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 · 2024-10-10T23:41:26Z

@ikevin127 this PR requires the API branch to be merged to return the correct results. You can start testing the selection functionality though, just don't expect accurate results in the search page until the API is deployed.

ikevin127 · 2024-10-11T19:15:34Z

@luacmartins Will start reviewing the functionality today, please let me know whether I should retest once the API pull request is merged (if so please notice me when that happened) or if the functionality is on point we can merge this regardless.

luacmartins · 2024-10-11T19:20:40Z

@ikevin127 the API was merged already, just waiting on deploy probably some time Monday

ikevin127 · 2024-10-11T19:57:31Z

🟢 Cool, the changes are looking good and functionality wise also nothing seems off - I'm going to wait for the API PR to be deployed so I can confirm that the filters are working as expected.

Will complete the Checklist now and retest to confirm once the API PR is deployed, please let me know when the API PR is deployed 👍

Edit: The ❌ TypeScript Checks seem to fail.

⚠️ I do have a UI related question which I think it's worth clarifying:

the issue's Expected result states:
this is how the search syntax UI looks currently on this PR with both filters applied:

What I want to clarify is whether we want the search syntax UI to show no:category || no:tag or keep it as is currently category:none || tag:none ?

cc @luacmartins @trjExpensify

ikevin127 · 2024-10-11T20:00:36Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2024-10-11T20:06:01Z

What I want to clarify is whether we want the search syntax UI to show no:category || no:tag or keep it as is currently category:none || tag:none ?

Ah yea, we changed that to category:none, etc. No more no filter.

luacmartins · 2024-10-11T20:07:06Z

TS checks failed because it couldn't connect to GH. Running again.

ikevin127

Just retested this and looks like the API PR was deployed because the filters work now 🚀

Screen.Recording.2024-10-14.at.13.31.40.mov

melvin-bot · 2024-10-14T20:37:14Z

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

marcaaron · 2024-10-15T19:42:21Z

src/pages/Search/AdvancedSearchFilters.tsx

+        return 1;
+    }
+    return localeCompare(a, b);
+};


OSBotify · 2024-10-15T19:53:34Z

✋ 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 · 2024-10-17T01:58:53Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.50-0 🚀

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

IuliiaHerets · 2024-10-17T08:39:11Z

This PR is failing because of issue #50984

mjasikowski · 2024-10-17T13:09:35Z

Will revert this one temporarily, until it's fixed.
The problem is most likely with https://github.com/Expensify/Auth/pull/12676. Categories work fine, but the query created for searching tags returns no results - this is because it checks for t.tags IS NULL, where as the empty tags are have actually empty string values, so should be checking for t.tags = '' or doing a coalesce(). Fixing this is relatively simple, but it produces another problem which I couldn't manage to fix quickly - that is making searching for "no tags" and tags with a value return valid results.
I've created a branch where SearchTest.cpp in auth has additional tests that cover the above: https://github.com/Expensify/Auth/tree/michal-fix-empty-tag-search

@luacmartins would you be able to work with this on fixing the issue?

luacmartins · 2024-10-17T17:04:23Z

I'll work on a fix for it

github-actions · 2024-10-18T18:47:43Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.50-8 🚀

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

luacmartins added 21 commits October 2, 2024 17:58

add no operator

9fc08a5

Merge branch 'main' into cmartins-addNoOperator

0afc4fe

add no operator

be73b22

add no as a valid filter

d1a8338

add comments

f353d36

display selection on filters page

524a0ee

use consts

c9a8451

add new section

8bf7a49

resolve conflicts

6de3a5a

Merge branch 'main' into cmartins-addNoOperator

cfff2e0

move option to list

bf6fe38

fix ts

4c1bffc

use const, apply logic to tags

7b08ff4

fix route, types

40f0430

revert changes, add entry to list

29e01cd

update sort logic

8b165db

update display value in filter list

223ad3d

update sorting function

84882b8

rename const

7169928

fix ts

bfc0cda

rename function

345a8ab

luacmartins marked this pull request as ready for review October 10, 2024 23:39

luacmartins requested a review from a team as a code owner October 10, 2024 23:39

melvin-bot bot requested a review from ikevin127 October 10, 2024 23:39

luacmartins self-assigned this Oct 10, 2024

melvin-bot bot removed the request for review from a team October 10, 2024 23:39

luacmartins changed the title ~~Add support for no filter~~ Support empty value for categories and tags Oct 10, 2024

Merge branch 'main' into cmartins-addNoOperator

7b9df4c

ikevin127 approved these changes Oct 14, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron October 14, 2024 20:37

marcaaron approved these changes Oct 15, 2024

View reviewed changes

src/pages/Search/AdvancedSearchFilters.tsx

return 1;

}

return localeCompare(a, b);

};

Copy link

Contributor

marcaaron Oct 15, 2024

Choose a reason for hiding this comment

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

NAB, DRY

marcaaron merged commit 67ceb7f into main Oct 15, 2024
17 checks passed

marcaaron deleted the cmartins-addNoOperator branch October 15, 2024 19:43

github-actions bot mentioned this pull request Oct 17, 2024

Deploy Checklist: New Expensify 2024-10-17 #50969

Closed

90 tasks

IuliiaHerets mentioned this pull request Oct 17, 2024

Search - Search doesn't show expenses when applied tag filters #50984

Closed

8 tasks

IuliiaHerets mentioned this pull request Oct 17, 2024

Search - "No category" is no longer selected in Categories field after searching with filter #50989

Closed

8 tasks

mjasikowski mentioned this pull request Oct 17, 2024

[CP Staging] Revert "Support empty value for categories and tags" #51015

Merged

ikevin127 mentioned this pull request Oct 17, 2024

[HOLD for payment 2024-10-30] [CRI] [Search v2.2] Add No category and No tag search filters #49675

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support empty value for categories and tags #50122

Support empty value for categories and tags #50122

luacmartins commented Oct 2, 2024 •

edited

Loading

melvin-bot bot commented Oct 10, 2024

luacmartins commented Oct 10, 2024

ikevin127 commented Oct 11, 2024

luacmartins commented Oct 11, 2024

ikevin127 commented Oct 11, 2024 •

edited

Loading

ikevin127 commented Oct 11, 2024 •

edited

Loading

luacmartins commented Oct 11, 2024

luacmartins commented Oct 11, 2024

ikevin127 left a comment

melvin-bot bot commented Oct 14, 2024

marcaaron Oct 15, 2024

OSBotify commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

IuliiaHerets commented Oct 17, 2024

mjasikowski commented Oct 17, 2024 •

edited

Loading

luacmartins commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

Support empty value for categories and tags #50122

Support empty value for categories and tags #50122

Conversation

luacmartins commented Oct 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 10, 2024

luacmartins commented Oct 10, 2024

ikevin127 commented Oct 11, 2024

luacmartins commented Oct 11, 2024

ikevin127 commented Oct 11, 2024 • edited Loading

ikevin127 commented Oct 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins commented Oct 11, 2024

luacmartins commented Oct 11, 2024

ikevin127 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 14, 2024

marcaaron Oct 15, 2024

Choose a reason for hiding this comment

OSBotify commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

IuliiaHerets commented Oct 17, 2024

mjasikowski commented Oct 17, 2024 • edited Loading

luacmartins commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

luacmartins commented Oct 2, 2024 •

edited

Loading

ikevin127 commented Oct 11, 2024 •

edited

Loading

ikevin127 commented Oct 11, 2024 •

edited

Loading

mjasikowski commented Oct 17, 2024 •

edited

Loading