App icon indicating copy to clipboard operation
App copied to clipboard

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

Open Krishna2323 opened this issue 11 months ago • 22 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/36485 PROPOSAL: https://github.com/Expensify/App/issues/36485#issuecomment-1943884263

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
  • [x] 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
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/Expensify/App/assets/85894871/ddcbe525-ea93-47cf-bc3f-55d8898cdbc7

Android: mWeb Chrome

https://github.com/Expensify/App/assets/85894871/0792b4a6-0434-41f0-be40-8fb9abc30730

iOS: Native

https://github.com/Expensify/App/assets/85894871/28745c33-98bf-4955-bfef-7fe1d3bd3a79

iOS: mWeb Safari

https://github.com/Expensify/App/assets/85894871/0c54c7a1-0123-41bf-a05e-bf063e138df9

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/85894871/88cecc41-6b55-4182-b067-ac4c6951ee75

MacOS: Desktop

https://github.com/Expensify/App/assets/85894871/6dac9460-7907-445d-8a5b-cd29fb73a281

Krishna2323 avatar Feb 28 '24 09:02 Krishna2323

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

melvin-bot[bot] avatar Feb 28 '24 09:02 melvin-bot[bot]

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

Krishna2323 avatar Feb 28 '24 09:02 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.

https://github.com/Expensify/App/assets/85894871/0519f40e-f087-45e2-8ef4-ef333e93bcc2

Krishna2323 avatar Mar 04 '24 07:03 Krishna2323

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

alitoshmatov avatar Mar 06 '24 05:03 alitoshmatov

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.

dangrous avatar Mar 06 '24 20:03 dangrous

@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: https://github.com/Expensify/App/blob/9302ade9988b1cba3e07b48f474bc35a6deea7fb/src/libs/OptionsListUtils.ts#L1087-L1090

https://github.com/Expensify/App/assets/85894871/531a8de4-ff98-4ab7-b56f-4e3441fa8a68

Krishna2323 avatar Mar 09 '24 14:03 Krishna2323

@alitoshmatov, PR is ready, screenshots added.

Krishna2323 avatar Mar 11 '24 10:03 Krishna2323

@Krishna2323 Can you resolve conflicts

alitoshmatov avatar Mar 13 '24 13:03 alitoshmatov

So as far as I understand original issue stated that tags were grayed out when they were disabled and categories were not, the objective was to grey out category items when they were disabled. But now tags also are not greyed out nor the cursor is disabled.

@Krishna2323 I am not understanding clear goal from this PR right now, I see you discovered the bug and applied solution to it.

@dangrous What do you think our next move should be,

  • should we discard our original objective since both tags and categories are the same now?
  • ~Should we move on with bug discovered by @Krishna2323 and apply the solution he provided?~ Looks like GH issue is created for this purpose(https://github.com/Expensify/App/issues/38226), would be best if we resolve this here since we it is related and @Krishna2323 already has valid solution

I am leaning to leaving categories and tags as it is since their behavior is the same now, and continue with @Krishna2323 solution

alitoshmatov avatar Mar 13 '24 13:03 alitoshmatov

@alitoshmatov, we now also have a open GH issue also😆. https://github.com/Expensify/App/issues/38226

Krishna2323 avatar Mar 13 '24 13:03 Krishna2323

Thank you, I will update our next options accordingly

alitoshmatov avatar Mar 13 '24 13:03 alitoshmatov

Hrm I might bring in @Expensify/design to confirm what the expected UX for disabled categories/tags is. @alitoshmatov / @Krishna2323 can you clarify what currently happens (without any changes made here) to make sure it's correct?

And then yeah I think we can roll in that new issue you found.

dangrous avatar Mar 13 '24 15:03 dangrous

Currently, you have money request and specific category and tag is selected for this. If you disabled that selected category and/or tag from OD and in ND open categories or tag in money request disabled tags appear as normal(previously they were grayed out and mouse was disabled).

Note: Not disabling cursor kinda makes sense, since you can just click on that category or tag to unselect it without selecting new item

alitoshmatov avatar Mar 13 '24 15:03 alitoshmatov

Is this in any way related to this convo we recently had in Slack about disabled categories?

Basically disabled categories (or tags) that are currently selected should look disabled, still have the checkmark, and the user should be able to interact with it only to remove the selection. Once the selection has been removed, I don't think the disabled category (or tag) would show up in the list anymore. Does that sound right @shawnborton?

dannymcclain avatar Mar 13 '24 15:03 dannymcclain

For comparison

Then: Screenshot 2024-03-13 at 8 55 54 PM

Now: Screenshot 2024-03-13 at 8 58 17 PM

alitoshmatov avatar Mar 13 '24 15:03 alitoshmatov

Basically disabled categories (or tags) that are currently selected should look disabled, still have the checkmark, and the user should be able to interact with it only to remove the selection. Once the selection has been removed, I don't think the disabled category (or tag) would show up in the list anymore. Does that sound right @shawnborton?

That makes sense to me, though I guess we'd still show the selected BG color on the row too right?

shawnborton avatar Mar 13 '24 16:03 shawnborton

though I guess we'd still show the selected BG color on the row too right?

Yeah I think we would.

dannymcclain avatar Mar 13 '24 16:03 dannymcclain

Are you clear on how to move forward @alitoshmatov ? Let us know and if not we can figure out how to clarify!

dangrous avatar Mar 18 '24 15:03 dangrous

Everything is clear to me and I have figured out the way to do it but before making changes I believe we need to also update TagPicker to not use OptionsSelector as it is deprecated and making changes to it isn't worth.

https://github.com/Expensify/App/blob/0fa4d0f2a200d58af452fa6c37bdc27b7f7fe2d5/src/components/TagPicker/index.js#L61

@dangrous, what do you think, should we change the OptionsSelector also? I that's the case I think bounty should be increased then because updating OptionsSelector to SelectionList is complicated and has high chances of causing regressions.

Krishna2323 avatar Mar 20 '24 13:03 Krishna2323

Hm, yeah, I think we should probably update both. Do you mind posting in the issue and we can involve the BZ team in any update on pricing?

dangrous avatar Mar 21 '24 15:03 dangrous

Commented on the issue, @Krishna2323 can you please keep this PR moving along, another issue is held on it. Thx

mallenexpensify avatar Mar 28 '24 23:03 mallenexpensify

@alitoshmatov, you can review this PR now :), will fix jest unit tests next.

Krishna2323 avatar Mar 31 '24 14:03 Krishna2323

@alitoshmatov, the PR is ready for review. Multiple bugs have been fixed.

  1. Selected disabled tag/category/tax with disabled style but still deselectable.
  2. Selected disabled category not shown when searching.
  3. Selected disabled tax not shown when searching.

I reverted the OptionSelcetor migration changes in TaxPicker because it is recently migrated to SelectionList in some other PR.

Krishna2323 avatar Apr 20 '24 19:04 Krishna2323

@alitoshmatov, friendly bump for review.

Krishna2323 avatar Apr 23 '24 19:04 Krishna2323

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

https://github.com/Expensify/App/assets/59907218/48534bef-d6b1-460f-b57f-1de324a607e0

alitoshmatov avatar Apr 24 '24 05:04 alitoshmatov

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

Krishna2323 avatar Apr 26 '24 02:04 Krishna2323

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/59907218/a082e30a-7008-4427-b260-f242921d6439

Android: mWeb Chrome
iOS: Native

https://github.com/Expensify/App/assets/59907218/799e5786-c811-4c73-864c-7033f667ec19

iOS: mWeb Safari

https://github.com/Expensify/App/assets/59907218/ee5cf09a-a074-41c7-9971-4b12f961fb9a

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/59907218/4c497254-5502-4d1a-8c16-5c1d089fb721

MacOS: Desktop

https://github.com/Expensify/App/assets/59907218/af5176a1-7562-437e-959d-2fa46d5de8ae

alitoshmatov avatar Apr 30 '24 18:04 alitoshmatov

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

Krishna2323 avatar Apr 30 '24 18:04 Krishna2323

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

Krishna2323 avatar May 01 '24 05:05 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.

https://github.com/Expensify/App/blob/2f5173c9c0f041967acfbdf9581ce52327623fa6/tests/unit/OptionsListUtilsTest.ts#L1300-L1301 https://github.com/Expensify/App/blob/2f5173c9c0f041967acfbdf9581ce52327623fa6/tests/unit/OptionsListUtilsTest.ts#L821-L826

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.

https://github.com/Expensify/App/blob/2f5173c9c0f041967acfbdf9581ce52327623fa6/tests/unit/OptionsListUtilsTest.ts#L1255-L1268

https://github.com/Expensify/App/blob/2f5173c9c0f041967acfbdf9581ce52327623fa6/tests/unit/OptionsListUtilsTest.ts#L1013-L1021

Krishna2323 avatar May 03 '24 22:05 Krishna2323