App icon indicating copy to clipboard operation
App copied to clipboard

Fix/35134: Auto select category and tag

Open dukenv0307 opened this issue 1 year ago • 1 comments

Details

  • Include auto-selection of tags/categories when a single option is available

Fixed Issues

$ https://github.com/Expensify/App/issues/35134 PROPOSAL: https://github.com/Expensify/App/issues/35134#issuecomment-1909769624

Tests

  1. Click on FAB => Choose "Request money" => Choose "Manual"
  2. Enter amount
  3. Select a workspace that has only one option variable in search category-tag
  4. In confirmation screen, verify that the category/tag are auto selected.
  • [x] Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Click on FAB => Choose "Request money" => Choose "Manual"
  2. Enter amount
  3. Select a workspace that has only one option variable in search category-tag
  4. In confirmation screen, verify that the category/tag are auto selected.
  • [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
Android: mWeb Chrome

Screencast from 06-02-2024 07:50:40.webm

iOS: Native
iOS: mWeb Safari

Screencast from 06-02-2024 07:53:12.webm

MacOS: Chrome / Safari

Screencast from 06-02-2024 07:47:31.webm

MacOS: Desktop

dukenv0307 avatar Feb 06 '24 01:02 dukenv0307

@jjcoffee 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 06 '24 01:02 melvin-bot[bot]

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/27287420/606d6f44-c37f-4eb0-88ea-1f8fea27d2db

Android: mWeb Chrome

https://github.com/Expensify/App/assets/27287420/872cfdd9-2d3b-4a93-ac55-4a74257ffcab

iOS: Native

https://github.com/Expensify/App/assets/27287420/ad55f809-ccd1-417e-a254-e18c1fd26b1a

iOS: mWeb Safari

https://github.com/Expensify/App/assets/27287420/24644bf2-6e95-4a6f-ac4e-2f2a66e0493f

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/27287420/e7b08b99-8274-4dab-98ef-8858b94a798a

MacOS: Desktop

https://github.com/Expensify/App/assets/27287420/b27a669e-976d-4259-9bca-2db7a5b37162

jjcoffee avatar Feb 06 '24 10:02 jjcoffee

@dukenv0307 I think it's a bit clearer if the first test step is "Set up a workspace with only one tag and one category enabled".

jjcoffee avatar Feb 06 '24 10:02 jjcoffee

@dukenv0307 Could you add an Android native screenshot?

jjcoffee avatar Feb 06 '24 10:02 jjcoffee

@jjcoffee I fixed all your 3 comments

dukenv0307 avatar Feb 07 '24 11:02 dukenv0307

@dukenv0307 Let's limit this to only auto-select if the category or tag is required (per this comment). I've not had feedback on whether or not we should hold for the multi-level tags PR (https://github.com/Expensify/App/pull/34983) but it might be worth waiting for that anyway before doing any more work here.

jjcoffee avatar Feb 08 '24 11:02 jjcoffee

That PR should be getting merged today.

jjcoffee avatar Feb 15 '24 10:02 jjcoffee

Merged! @dukenv0307 Are you able to rework this to handle multi-level tags and to only auto-select if the tag/category is required?

jjcoffee avatar Feb 16 '24 10:02 jjcoffee

@jjcoffee Added the logic to handle:

  1. Multiple level tags
  2. Only auto-select if the category or tag is required

dukenv0307 avatar Feb 19 '24 07:02 dukenv0307

Reported an unrelated bug here where all multi-level tags show as required if the workspace originally had "People must tag expenses" enabled.

jjcoffee avatar Feb 22 '24 13:02 jjcoffee

@dukenv0307 Can you merge main to fix conflicts?

jjcoffee avatar Mar 05 '24 11:03 jjcoffee

@puneetlath To summarise some of the implementation details here:

  • Due to the BE issue we've discussed on Slack, auto-select for single-level tags will not work correctly currently. This is because the tag list for them does not have the correct required field (it's there, it just gets stuck on either true or false and never updates). We could use requiresTag from the policy for single-level tags as a workaround, but I guess we can expect the BE issue to be fixed at some point!
  • Changing the required status of a tag or category on OD whilst a money request screen is open won't revert the auto-selected category/tag. There's no pusher event to support this, so I thought it makes sense to leave it out of the scope of this PR.

jjcoffee avatar Mar 05 '24 11:03 jjcoffee

@dukenv0307 Sorry forgot to say, can you add to the test steps the pre-requisite that the violations beta needs to be enabled? :pray:

jjcoffee avatar Mar 05 '24 13:03 jjcoffee

@jjcoffee I updated test steps based on your comment

dukenv0307 avatar Mar 05 '24 13:03 dukenv0307

can you also make sure to report the BE issue in #expensify-bugs so we make sure it gets handled.

@puneetlath Yuwen has pushed a fix, just waiting for it to hit production.

jjcoffee avatar Mar 06 '24 09:03 jjcoffee

:hand: 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 avatar Mar 07 '24 21:03 OSBotify

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.49-0 🚀

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

OSBotify avatar Mar 08 '24 00:03 OSBotify

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

OSBotify avatar Mar 12 '24 18:03 OSBotify