Don't categorize when searching in report fields selection page by bernhardoj · Pull Request #37583 · Expensify/App

bernhardoj · 2024-03-01T05:36:57Z

Details

We don't want to categorize the search result when searching in report fields selection page to make it consistent with other pages.

Fixed Issues

$ #36683
PROPOSAL: #36683 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Precondition:

User is an employee of Collect workspace
The Collect workspace has dropdown field set up in "Report and Invoice Fields" on Old Dot

Go to a collect workspace chat.
Create a request.
Go to the expense report.
Click on the report field with the selection list set up from Old Dot
Select an item.
Click on the report field again.
Search for a term that will return results in the Recent and All sections
Verify the search results are not categorized in Recent and All sections

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-21.at.23.17.11.mov

Android: mWeb Chrome

Screen.Recording.2024-03-21.at.23.20.18.mov

iOS: Native

Screen.Recording.2024-03-21.at.23.17.55.mov

iOS: mWeb Safari

Screen.Recording.2024-03-21.at.23.15.10.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-21.at.23.12.39.mov

MacOS: Desktop

Screen.Recording.2024-03-21.at.23.13.48.mov

melvin-bot · 2024-03-01T05:37:02Z

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

hungvu193 · 2024-03-03T11:11:44Z

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.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android.mWeb.chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mwebSafari.mov

MacOS: Chrome / Safari

chrome.mov

MacOS: Desktop

desktop.mov

hungvu193

Changes look good and test well!

MonilBhavsar · 2024-03-04T05:53:42Z

+                shouldShow: restOfOptions.length > 0,
+                data: restOfOptions.map((option) => ({


Under `all' we should display everything.
Please check behavior for categories and tags

Hmm, if we show it on both category, there will be 2 checkmarks.

For category, we have a selected section and it's not included in either Recent or All.

@bernhardoj I think we should filter the selected option like we did with category.

App/src/libs/OptionsListUtils.ts

Line 1045 in 8f58c57

const filteredCategories = enabledCategories.filter((category) => !selectedOptionNames.includes(category.name));

So the All section will include all the options except the selected option, that's the expected right? @MonilBhavsar

This is how it will looks if we follow category page.

Yes, "All" section includes all options except selected

…-searching

hungvu193 · 2024-03-04T09:43:55Z

@bernhardoj I'm facing this crash while trying to create new expense, can you check it?

Screen.Recording.2024-03-04.at.16.38.38.mov

Steps to reproduce:

Go to the workspace that you've created new expense.
Create another expense
Click on the report field.

bernhardoj · 2024-03-04T09:47:47Z

Can't reproduce it. Can you share the console error in text? I can only see invalid prop console error in your video.

hungvu193 · 2024-03-04T09:48:50Z

Here's the console, but let me re-create another collect workspace and try again.

MonilBhavsar · 2024-03-04T09:57:31Z

Also, this code is wrong, no?

App/src/pages/EditReportFieldPage.tsx

Line 46 in 35356da

    
           const reportField = report?.reportFields?.[route.params.fieldID] ?? policyReportFields?.[route.params.fieldID];

Looks like fieldIDs are stored as expensify_field_id_PROJECT and in url it is only field_id_PROJECT
So i think it should be

const reportField = report?.reportFields?.['expensify_' + route.params.fieldID] ?? policyReportFields?.['expensify_' + route.params.fieldID];

hungvu193 · 2024-03-04T10:02:30Z

I can't reproduce the crash but If I create a fresh collect workspace, and request the expense, when I click the report field without anything selected it will show "Hidden", is this expected?

Screen.Recording.2024-03-04.at.16.56.42.mov

Also if I delete the selected option and select another options, "Recent" and "All" will also show even they're empty.

Screen.Recording.2024-03-04.at.17.01.17.mov

bernhardoj · 2024-03-04T12:22:12Z

Looks like fieldIDs are stored as expensify_field_id_PROJECT and in url it is only field_id_PROJECT
So i think it should be

Yeah, looks like there are some recent BE changes. I see not found page when accessing it.

@hungvu193 fixed both issues. The selected value is empty, so hidden is shown

App/src/components/DisplayNames/index.tsx

Line 9 in af0f6a3

const title = fullTitle || translate('common.hidden');

The second issue, is the condition to show the recent section title doesn't exclude the selected value yet.

hungvu193 · 2024-03-04T14:01:18Z

Looks like fieldIDs are stored as expensify_field_id_PROJECT and in url it is only field_id_PROJECT
So i think it should be

Yeah, looks like there are some recent BE changes. I see not found page when accessing it.

@hungvu193 fixed both issues. The selected value is empty, so hidden is shown

App/src/components/DisplayNames/index.tsx

Line 9 in af0f6a3

const title = fullTitle || translate('common.hidden');

The second issue, is the condition to show the recent section title doesn't exclude the selected value yet.

I can confirm these issues are fixed 👍

MonilBhavsar · 2024-03-04T14:54:55Z

Bug?

I have a2 selected(see background) but checked option is a1

bernhardoj · 2024-03-04T15:05:35Z

@MonilBhavsar Do you have any reliable repro steps? I can't reproduce it

MonilBhavsar · 2024-03-04T16:14:36Z

No specific rules, but is not related to this PR

MonilBhavsar · 2024-03-04T16:57:14Z

+        const filteredRecentlyUsedOptions = recentlyUsedOptions.filter((option) => option !== selectedValue);
+        const filteredFieldOptions = fieldOptions.filter((option) => option !== selectedValue);


Let's declared them below when they're used?

MonilBhavsar · 2024-03-04T16:58:33Z

-            {
+        const selectedValue = fieldValue;
+
+        setHeaderMessage(!fieldOptions.length && !recentlyUsedOptions.length ? translate('common.noResultsFound') : '');


Why we need this block and that too outside of if (searchValue) {} block

To show the no result found text. I'm not sure if I answer your question 😆

Isn't that case handled when search value is present and on L51 above?

I can access a report field without a list, so I think we still need it for now, except we hide the report field if it doesn't have a list.

@MonilBhavsar Can you confirm the expected behavior when the report field is empty? We should still show the report field, allow user to click on it and it will show no result found (like current code) or we should remove or disable report field when it's empty?

Yes, sorry if it was unclear. Let's not include those changes in this PR.

So let remove the line 67 and other changes will be in the next PR right?

Yes, we can remove that line 67 👍

thienlnam · 2024-03-04T18:35:15Z

As a note, we're currently making some changes to what the reportFields return in the BE. The FE changes are being updated in #36170

…-searching

MonilBhavsar · 2024-03-06T11:58:23Z

As a note, we're currently making some changes to what the reportFields return in the BE. The FE changes are being updated in #36170

Thanks! Those changes looks unrelated to this PR, so we should still continue with this PR

…-searching

bernhardoj · 2024-03-21T07:36:39Z

The not found issue is fixed, but I found another issue after we remove the line 67.

Screen.Recording.2024-03-21.at.15.30.02.mov

Do we want to readd it back but we willl just set it to empty string,

const [headerMessage, setHeaderMessage] = useState('');
if (searchValue) {
    setHeaderMessage(!filteredOptions.length ? translate('common.noResultsFound') : '');
    ...
    return;
}

setHeaderMessage('');

or we can do it like this:

const headerMessage = searchValue && sections[0].data.length === 0 ? translate('common.noResultsFound') : '';

@hungvu193

hungvu193 · 2024-03-21T07:57:26Z

The not found issue is fixed, but I found another issue after we remove the line 67.

Screen.Recording.2024-03-21.at.15.30.02.mov
Do we want to readd it back but we willl just set it to empty string,
const [headerMessage, setHeaderMessage] = useState('');
if (searchValue) {
    setHeaderMessage(!filteredOptions.length ? translate('common.noResultsFound') : '');
    ...
    return;
}

setHeaderMessage('');
or we can do it like this:
const headerMessage = searchValue && sections[0].data.length === 0 ? translate('common.noResultsFound') : '';

I see. I prefer the second option (just make sure you use useMemo).
Or we can combine both like this:

const {headerMessage, sections} = useMemo(() => {}, [])

bernhardoj · 2024-03-21T08:11:49Z

Updated based on your suggestion

hungvu193

@bernhardoj Just one small change. Also please remove the HOLD from PR's title.

hungvu193 · 2024-03-21T13:03:58Z

+
+    const {sections, headerMessage} = useMemo(() => {
+        let newHeaderMessage = '';
+        const newSections = [];


Can you add the type definition of newSections here?

bernhardoj · 2024-03-21T13:13:32Z

Done.

MonilBhavsar · 2024-03-21T13:37:46Z

@hungvu193 @bernhardoj Just making sure this checklist item was followed as all screenshots are old

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.

hungvu193 · 2024-03-21T13:45:34Z

@hungvu193 @bernhardoj Just making sure this checklist item was followed as all screenshots are old

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.

My bad 🤦 , I forgot we changed expected behavior after few discussions. I'm updating them now.

hungvu193 · 2024-03-21T13:58:32Z

Checklist updated

bernhardoj · 2024-03-21T15:23:26Z

Updated

MonilBhavsar · 2024-03-22T06:53:49Z

Thanks! Performance tests are failing. You might want to merge main?

…-searching

hungvu193 · 2024-03-22T07:54:54Z

Thanks! Performance tests are failing. You might want to merge main?

All check passed! All yours @MonilBhavsar

MonilBhavsar

Thanks all!

melvin-bot · 2024-03-22T08:49:25Z

@MonilBhavsar looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

MonilBhavsar · 2024-03-22T08:54:22Z

All tests we passing!

OSBotify · 2024-03-22T08:55:09Z

✋ 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-03-22T16:19:57Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.56-0 🚀

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

OSBotify · 2024-03-27T04:49:06Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

don't categorize when searching

016d7a9

bernhardoj requested a review from a team as a code owner March 1, 2024 05:36

melvin-bot Bot requested review from hungvu193 and removed request for a team March 1, 2024 05:37

hungvu193 approved these changes Mar 3, 2024

View reviewed changes

melvin-bot Bot requested a review from MonilBhavsar March 3, 2024 11:32

MonilBhavsar reviewed Mar 4, 2024

View reviewed changes

bernhardoj added 4 commits March 4, 2024 15:34

Merge branch 'main' into fix/36683-dont-categorized-report-field-when…

256d009

…-searching

don't include selected value in recent and all

fc05a9f

fix lint

24309d6

prettier

7a13578

conditionally add the section when it's not empty

6f58e2f

MonilBhavsar reviewed Mar 4, 2024

View reviewed changes

bernhardoj added 2 commits March 5, 2024 11:49

moving code around

563ed6a

Merge branch 'main' into fix/36683-dont-categorized-report-field-when…

d8e7885

…-searching

Merge branch 'main' into fix/36683-dont-categorized-report-field-when…

526d880

…-searching

Merge branch 'main' into fix/36683-dont-categorized-report-field-when…

7041cfa

…-searching

get the header message from section data

204d486

rename

500c4c9

hungvu193 suggested changes Mar 21, 2024

View reviewed changes

bernhardoj changed the title ~~[HOLD #36553] Don't categorize when searching in report fields selection page~~ Don't categorize when searching in report fields selection page Mar 21, 2024

add type

693178d

prettier

d8aa7fa

hungvu193 approved these changes Mar 21, 2024

View reviewed changes

melvin-bot Bot requested a review from MonilBhavsar March 21, 2024 13:29

Merge branch 'main' into fix/36683-dont-categorized-report-field-when…

fe25607

…-searching

MonilBhavsar approved these changes Mar 22, 2024

View reviewed changes

MonilBhavsar merged commit 408a894 into Expensify:main Mar 22, 2024

melvin-bot Bot added the Emergency label Mar 22, 2024

MonilBhavsar removed the Emergency label Mar 22, 2024

github-actions Bot mentioned this pull request Mar 22, 2024

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

		shouldShow: restOfOptions.length > 0,
		data: restOfOptions.map((option) => ({

		const filteredRecentlyUsedOptions = recentlyUsedOptions.filter((option) => option !== selectedValue);
		const filteredFieldOptions = fieldOptions.filter((option) => option !== selectedValue);

Uh oh!

Conversation

bernhardoj commented Mar 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 1, 2024

Uh oh!

hungvu193 commented Mar 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hungvu193 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hungvu193 Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hungvu193 commented Mar 4, 2024

Uh oh!

bernhardoj commented Mar 4, 2024

Uh oh!

hungvu193 commented Mar 4, 2024

Uh oh!

MonilBhavsar commented Mar 4, 2024

Uh oh!

hungvu193 commented Mar 4, 2024

Uh oh!

bernhardoj commented Mar 4, 2024

Uh oh!

hungvu193 commented Mar 4, 2024

Uh oh!

MonilBhavsar commented Mar 4, 2024

Uh oh!

bernhardoj commented Mar 4, 2024

Uh oh!

MonilBhavsar commented Mar 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Mar 1, 2024 •

edited

Loading

hungvu193 commented Mar 3, 2024 •

edited

Loading

hungvu193 Mar 4, 2024 •

edited

Loading