fix: IOU - Disabled tag is greyed in list but disabled category is shown bold in list.

[Krishna2323]

Details

Fixed Issues

$ #36485
PROPOSAL: #36485 (comment)

Tests

1. Launch app as employee
2. Create a manual request > Enter amount > Select employee workspace chat
3. Enter merchant > Select any category > Create request
4. In admin account, disable the category used to create above expense
5. In employee account, in Workspace chat, open the newly created request to open details page.
6. Open category edit page by clicking on the category
7. Verify disabled category is visible
8. Search for the category and verify disabled category is appears in the search result with the checkmark
9. Change category to any other option > Search for the changed category
10. Verify category is appears in the search result with the checkmark

• Verify that no errors appear in the JS console

Offline tests

1. Launch app as employee
2. Create a manual request > Enter amount > Select employee workspace chat
3. Enter merchant > Select any category > Create request
4. In admin account, disable the category used to create above expense
5. In employee account, in Workspace chat, open the newly created request to open details page.
6. Open category edit page by clicking on the category
7. Verify disabled category is visible
8. Search for the category and verify disabled category is appears in the search result with the checkmark
9. Change category to any other option > Search for the changed category
10. Verify category is appears in the search result with the checkmark

QA Steps

1. Launch app as employee
2. Create a manual request > Enter amount > Select employee workspace chat
3. Enter merchant > Select any category > Create request
4. In admin account, disable the category used to create above expense
5. In employee account, in Workspace chat, open the newly created request to open details page.
6. Open category edit page by clicking on the category
7. Verify disabled category is visible
8. Search for the category and verify disabled category is appears in the search result with the checkmark
9. Change category to any other option > Search for the changed category
10. Verify category is appears in the search result with the checkmark

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

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

[melvin-bot]

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

[Krishna2323]

I'm still working on this and will probably finish it by the end of the day tomorrow.

[Krishna2323]

@alitoshmatov @dangrous, OptionsSelector is now deprecated, I have applied changes to disable the selected options if it is not in the list, because we currently use OptionsSelector for TagPicker we will get the greyed out text for disabled tag but for disabled category we will only show the disabled cursor. I just wan to confirm if we need to grey out text for disabled
category/tag or not, if thats the expected result we need to make minor changes to SelectionList & RadioListItem. Also, do we need it for all component which uses selection list or for this specific component. I mean the greyed out text styles.

fix_demo_disabled_tag_category.mp4

[alitoshmatov]

Not sure what is the best approach here. @dangrous Can you take a look at this.

I am leaning towards modifying SelectionList to show items greyed when they are disabled. But it will affect whole app and change its design slightly

[dangrous]

Yeah I think we should probably grey it out, it isn't super clear if it's only the cursor style. We should just do a set of testing to see if there's anywhere else it shows up greyed out unexpectedly - I think overall it's a clearer UI, though.

[Krishna2323]

@alitoshmatov @dangrous, The 'greyed out' issue seems to be fixed now, so I reverted all the changes related to it. However, I discovered a similar bug related to disabled categories while testing the fix. In the video below, you can see that the selected category is displayed even if it is disabled. However, when we search for it, it disappears. Additionally, the second bug occurs when we have a selected category (enabled) and we search for it, causing the check icon to disappear. Both issues have the same root cause, and I have made the necessary changes.

The reason why we don't want to don't disable the selected tag/category:

App/src/libs/OptionsListUtils.ts

Lines 1087 to 1090 in 9302ade

	name: option.name,
	// Should be marked as enabled to be able to be de-selected
	enabled: true,
	}));

category_tag_bugs.mp4

[Krishna2323]

@alitoshmatov, PR is ready, screenshots added.

[alitoshmatov]

@Krishna2323 Can you resolve conflicts

[Krishna2323]

@alitoshmatov, friendly bump for review.

[alitoshmatov]

@Krishna2323 Can you check recording below, disabled tag is not showing even if it was selected(Feel free to ping me on slack DM whenever needed)

Screen.Recording.2024-04-24.at.10.28.20.AM.mov

[Krishna2323]

@alitoshmato, ready for a review again, tested thoroughly this time.

[alitoshmatov]

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

disabled-tag-android.mov

Android: mWeb Chrome

iOS: Native

disabled-tag-ios.mp4

iOS: mWeb Safari

disabled-tag-safari.mp4

MacOS: Chrome / Safari

disabled-tag-web.mov

MacOS: Desktop

disabled-tag-desktop.mov

[alitoshmatov]

Finally! I think we can merge it

[Krishna2323]

@alitoshmatov, Thanks for the review 🤠, I need to fix unit test, will do in a hour.

[Krishna2323]

@dangrous, All checks have passed, you can merge after final reviewing.

[dangrous]

@Krishna2323 this looks good, but one question - can you explain the changes that you made to the tests? I get adding isSelected: undefined but not why the changes on lines 1070,1071,1239,1240.

Thank you!

[Krishna2323]

@dangrous

Explanation for 1239,1240.

On the line below, we use getFilteredOptions with emptyCategoriesList and selectedOptions. Previously, emptySelectedResultList was returning isDisabled: false & isSelected: false for the Medical category (which is selected). Since it is selected and not in the category list (emptyCategoriesList), we need to set isSelected & isDisabled to true. A selected option is considered disabled if it is not in the category list or is not enabled.

App/tests/unit/OptionsListUtilsTest.ts

Lines 1300 to 1301 in 2f5173c

	const emptyResult = OptionsListUtils.getFilteredOptions(OPTIONS.reports, OPTIONS.personalDetails, [], search, selectedOptions, [], false, false, true, emptyCategoriesList);
	expect(emptyResult.categoryOptions).toStrictEqual(emptySelectedResultList);

App/tests/unit/OptionsListUtilsTest.ts

Lines 821 to 826 in 2f5173c

	const selectedOptions: Array<Partial<ReportUtils.OptionData>> = [
	{
	name: 'Medical',
	enabled: true,
	},
	];

Explanation for 1070,1071.

Similar to the above, the medical category is selected, so we need to pass isSelected as true. However, in largeCategoriesList, we have the medical category, but as you can see in the below object, the enabled field is false. Therefore, again, we need to set isDisabled to true.

App/tests/unit/OptionsListUtilsTest.ts

Lines 1255 to 1268 in 2f5173c

	const largeResult = OptionsListUtils.getFilteredOptions(
	OPTIONS.reports,
	OPTIONS.personalDetails,
	[],
	emptySearch,
	selectedOptions,
	[],
	false,
	false,
	true,
	largeCategoriesList,
	recentlyUsedCategories,
	);
	expect(largeResult.categoryOptions).toStrictEqual(largeResultList);

App/tests/unit/OptionsListUtilsTest.ts

Lines 1013 to 1021 in 2f5173c

	Medical: {
	enabled: false,
	name: 'Medical',
	unencodedName: 'Medical',
	areCommentsRequired: false,
	'GL Code': '',
	externalID: '',
	origin: '',
	},

[Krishna2323]

@dangrous, friendly bump to check the comment above^

[dangrous]

Cool! That makes sense to me.

[OSBotify]

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

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.72-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.72-1 🚀

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