Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#26126: Tag picker sections #27765

Merged
merged 27 commits into from
Sep 20, 2023

Conversation

BeeMargarida
Copy link
Contributor

@BeeMargarida BeeMargarida commented Sep 19, 2023

Details

2nd PR for wave 6: tags. Contains:

  • Tag picker for more than 8 tags (search bar and sections)
  • Saves selected tag in iou
  • Sends selected tag to backend

This requires using staging server and add policy tags to a policy. I asked in the wave 6 chat, but this can also be mocked.

Mock data
  1. Go to a workspace page
  2. Copy the workspace/policyID in the URL
  3. In AuthScreens add the following code to the componentDidMount:
Onyx.set('policyTags_<POLICY ID>', {
    Department: {
        name: "Department",
        tags: {
            Accounting: {name: 'Accounting', enabled: true},
            Engineering: {name: 'Engineering', enabled: true},
            HR: {name: 'HR', enabled: true},
            Marketing: {name: 'Marketing', enabled: true},
        }
    }
});
Onyx.set('policyRecentlyUsedTags_<POLICY ID>', {
    "Department:" ["Engineering"]
});

Fixed Issues

$ #26126

Tests

NOTE: use the mock setup mentioned above and/or use staging server.

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears and allow to select a tag
  6. Search for a tag and it should filter
  7. Select a tag and verify that it goes back and shows the selected tag

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Select a tag and verify that it goes back and shows the selected tag
  8. Click the tag menu item again
  9. The selected tag should appear below the search bar as selected
  10. Select another tag
  11. Verify that it goes back and shows the selected tag

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Verify that it goes back and shows the selected tag
  8. Save the request money
  9. Start another money request
  10. Click that tag menu item
  11. See that the tag previously selected in the other money request appears in the "Recent" section
  12. Create another money request with another tag
  13. Repeat steps 9-12

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Verify that it goes back and shows the selected tag
  8. Save the request money
  9. Start another money request
  10. Click that tag menu item
  11. See that the tag previously selected in the other money request appears in the "Recent" section
  12. Create another money request with another tag
  13. Repeat steps 9-12
  14. Create another money request with the last tag in the "recent" section
  15. Repeat steps 9-11
  16. Check that the previously selected tag appears in the first place of the "recent" section.
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears and allow to select a tag
  6. Search for a tag and it should filter
  7. Select a tag and verify that it goes back and shows the selected tag

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Select a tag and verify that it goes back and shows the selected tag
  8. Click the tag menu item again
  9. The selected tag should appear below the search bar as selected
  10. Select another tag
  11. Verify that it goes back and shows the selected tag

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Verify that it goes back and shows the selected tag
  8. Save the request money
  9. Start another money request
  10. Click that tag menu item
  11. See that the tag previously selected in the other money request appears in the "Recent" section
  12. Create another money request with another tag
  13. Repeat steps 9-12

  1. Start a Money Request from inside the workspace report
  2. Choose any of the selectors and select a workspace (one with tags set up)
  3. Open the 'show more' section
  4. Click on the Tag menu item (should have the name of the tag type - example "Department")
  5. See that the tag menu picker appears
  6. Select a tag
  7. Verify that it goes back and shows the selected tag
  8. Save the request money
  9. Start another money request
  10. Click that tag menu item
  11. See that the tag previously selected in the other money request appears in the "Recent" section
  12. Create another money request with another tag
  13. Repeat steps 9-12
  14. Create another money request with the last tag in the "recent" section
  15. Repeat steps 9-11
  16. Check that the previously selected tag appears in the first place of the "recent" section.
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
w_t.mp4
Mobile Web - Chrome
wc_t.mp4
Mobile Web - Safari
ws_t.mp4
Desktop
desk_t.mp4
iOS
ios_t.mp4
Android
android_t.mp4

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left a few comments.

src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/components/TagPicker/index.js Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.js Show resolved Hide resolved
src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved
keyForList: 'Engineering',
searchText: 'Engineering',
tooltipText: 'Engineering',
isDisabled: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you confirm that we need to show disabled tags if they they are not parents? Because, for categories, we should hide disabled ones.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean parents? If you mean what you have in categories like 'Food > Meat', there isn't that in tags

Copy link
Contributor

Choose a reason for hiding this comment

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

Good. It is much easier 😅
But, anyway, should the app show disabled tags or hide?

Copy link
Contributor Author

@BeeMargarida BeeMargarida Sep 19, 2023

Choose a reason for hiding this comment

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

Good question,I think it's hide, due to this part in the design doc.
image

Should only show if the disabled tag was already picked, and should disappear if unpicked.

@BeeMargarida
Copy link
Contributor Author

Recent commits to the branch are not showing here, it looks like a GH problem.

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@lukemorawski lukemorawski left a comment

Choose a reason for hiding this comment

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

Looks solid! Just one minor comment :)

src/libs/OptionsListUtils.js Show resolved Hide resolved
@BeeMargarida BeeMargarida marked this pull request as ready for review September 19, 2023 16:03
@BeeMargarida BeeMargarida requested a review from a team as a code owner September 19, 2023 16:03
@melvin-bot melvin-bot bot requested review from burczu and removed request for a team September 19, 2023 16:03
@melvin-bot
Copy link

melvin-bot bot commented Sep 19, 2023

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

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

Added two tiny little comments - in general code looks good.

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
@burczu
Copy link
Contributor

burczu commented Sep 20, 2023

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 / Chrome
    • iOS / native
    • iOS / 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(themeColors.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 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

Web
27765-web.mov
Mobile Web - Chrome
27765-web-chrome.mov
Mobile Web - Safari
27765-web-safari.mov
Desktop
27765-desktop.mov
iOS
Screen.Recording.2023-09-20.at.13.13.56.mov
Android
27765-android.mov

@BeeMargarida
Copy link
Contributor Author

Updated!

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

Reviewed, tested and approved.

@melvin-bot melvin-bot bot requested a review from amyevans September 20, 2023 11:15
Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Looking great just a few small fixes!

src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/components/TagPicker/index.js Outdated Show resolved Hide resolved
src/components/TagPicker/index.js Outdated Show resolved Hide resolved
@BeeMargarida
Copy link
Contributor Author

@amyevans Updated!

@amyevans amyevans merged commit d00a4d6 into Expensify:main Sep 20, 2023
11 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.73-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

Comment on lines +38 to +44
const initialFocusedIndex = useMemo(() => {
if (isTagsCountBelowThreshold && selectedOptions.length > 0) {
return _.chain(policyTagList)
.values()
.findIndex((policyTag) => policyTag.name === selectedOptions[0].name, true)
.value();
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Disabled tags should have been filtered out. It caused this issue: #30465

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants