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 menu item and Tag picker (1st PR) #26954

Merged

Conversation

BeeMargarida
Copy link
Contributor

@BeeMargarida BeeMargarida commented Sep 7, 2023

Details

This PR includes the tag menu item in a Money Request Confirmation as well as a way of choosing another tag. The picker is still on it's simpler form, the more complex form will come in the next PR.
This is using mock data with the setup mentioned in the collapsed section below. It does not change the IOU data, this will come in another PR.

Note: I added support for this working by creating the money request from the FAB menu. Let me know if the solution implemented is correct.

Mock data
  1. Go to a workspace page
  2. Copy the workspace/policyID in the URL
  3. In MoneyRequestConfirmPage add the following code to a useEffect(() => {...}, []):
Onyx.set('policyTags_<POLICY ID>', {
    Accounting: {name: 'Accounting', enabled: true},
    Engineering: {name: 'Engineering', enabled: true},
    HR: {name: 'HR', enabled: true},
    Marketing: {name: 'Marketing', enabled: true},
});
Onyx.merge('iou', {
    tag: 'Marketing',
});

Fixed Issues

$ #26126

Tests

  1. Start a Money Request from inside a report or in the FAB button
  2. Choose any of the selectors
  3. Open the 'show more' section
  4. Click on the Tag menu item
  5. See that the tag menu picker appears and allow to select one tag
  • Verify that no errors appear in the JS console

Offline tests

  1. Start a Money Request from inside a report or in the FAB button
  2. Choose any of the selectors
  3. Open the 'show more' section
  4. Click on the Tag menu item
  5. See that the tag menu picker appears and allow to select one tag

QA Steps

  1. Start a Money Request from inside a report or in the FAB button
  2. Choose any of the selectors
  3. Open the 'show more' section
  4. Click on the Tag menu item
  5. See that the tag menu picker appears and allow to select one tag
  • 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
webs_t.mp4
webc_t.mp4
Mobile Web - Chrome
mchrome_t.mp4
Mobile Web - Safari
msafari_t.mp4
Desktop
desktop_t.mp4
iOS
ios_t.mp4
Android
android_t.mp4

@BeeMargarida BeeMargarida marked this pull request as ready for review September 7, 2023 14:22
@BeeMargarida BeeMargarida requested a review from a team as a code owner September 7, 2023 14:22
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team September 7, 2023 14:22
@melvin-bot
Copy link

melvin-bot bot commented Sep 7, 2023

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

@rushatgabhane
Copy link
Member

rushatgabhane commented Sep 8, 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
Screen.Recording.2023-09-11.at.02.18.13.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop image
iOS
Screen.Recording.2023-09-11.at.03.00.27.mov
Android
Screen.Recording.2023-09-11.at.10.36.32.mov

@BeeMargarida
Copy link
Contributor Author

@rushatgabhane I made a commit containing the types and a correction to the recently used tags collection. It should not cause any difference in behaviour, since this is currently using mock data. This came from a review from #26501, which I'm also covering now.

@rushatgabhane
Copy link
Member

We’ll add a new user-level NVP, recentlyUsedTags, which we’ll use to store the names of the five most recently used tags, per policy, for each user

@BeeMargarida this is from the design doc. Would recently used tags be part of next PRs?

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM!

just left some non blocking comments

src/CONST.ts Show resolved Hide resolved
src/components/TagPicker/tagPickerPropTypes.js Outdated Show resolved Hide resolved
src/components/TagPicker/tagPickerPropTypes.js Outdated Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/components/TagPicker/index.js Show resolved Hide resolved
src/components/tagPropTypes.js Show resolved Hide resolved
@melvin-bot melvin-bot bot requested a review from amyevans September 11, 2023 04:18
Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

More than 8 tags
When a policy has 8 or more tags, we'll render up to three sections, as well as show the text input for search.

@BeeMargarida as per the design doc,

  1. when we have more than 8 tags we should show search input.
  2. If a tag name is super long, it will continue onto a second line in the same OptionRow.

Is this in scope on this PR?

image image

@BeeMargarida
Copy link
Contributor Author

BeeMargarida commented Sep 11, 2023

We’ll add a new user-level NVP, recentlyUsedTags, which we’ll use to store the names of the five most recently used tags, per policy, for each user

@BeeMargarida this is from the design doc. Would recently used tags be part of next PRs?

Will be implemented in the next PR, since it's the one that will contain sections in the tag picker component.

@BeeMargarida as per the design doc,

1. when we have more than 8 tags we should show search input.

2. If a tag name is super long, it will continue onto a second line in the same OptionRow.

Is this in scope on this PR?

No, it will come in the next one. This one is only for the less than 8 tags. In the next one, I'll include the complete tag picker behaviour, including that super long behaviour.

@BeeMargarida
Copy link
Contributor Author

@rushatgabhane Update and ready for another review

src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/components/tagPropTypes.js Outdated Show resolved Hide resolved
src/pages/iou/MoneyRequestTagPage.js Outdated Show resolved Hide resolved
src/pages/iou/MoneyRequestTagPage.js Show resolved Hide resolved
src/types/onyx/PolicyTag.ts Outdated Show resolved Hide resolved
@BeeMargarida
Copy link
Contributor Author

Updated!

amyevans
amyevans previously approved these changes Sep 12, 2023
@amyevans
Copy link
Contributor

@puneetlath all you!

Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

Looks good! A couple tiny comments.

src/components/MoneyRequestConfirmationList.js Outdated Show resolved Hide resolved
src/components/TagPicker/tagPickerPropTypes.js Outdated Show resolved Hide resolved
@BeeMargarida
Copy link
Contributor Author

@puneetlath Ready for a review

puneetlath
puneetlath previously approved these changes Sep 13, 2023
Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

Looks good, but more conflicts 😢

@BeeMargarida
Copy link
Contributor Author

Conflicts fixed!

@amyevans amyevans merged commit d494433 into Expensify:main Sep 13, 2023
13 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.

@ayazhussain79
Copy link
Contributor

How can i see tags ?

Screenshot 2023-09-13 at 10 52 50 PM

@OSBotify
Copy link
Contributor

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

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

@@ -499,6 +520,16 @@ function MoneyRequestConfirmationList(props) {
disabled={didConfirm || props.isReadOnly}
/>
)}
{canUseTags && !!tagList && (
Copy link
Contributor

Choose a reason for hiding this comment

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

I just noticed this line is incorrect, we should use !_.isEmpty(tagList) instead of !!tagList. @BeeMargarida can you add that change to your next PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yap!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

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.

Good job. Looks solid!

// Fetches the first tag list of the policy
const tagListKey = _.first(_.keys(policyTags));
const tagList = lodashGet(policyTags, tagListKey, {});
const tagListName = lodashGet(tagList, 'name', '');
Copy link
Contributor

Choose a reason for hiding this comment

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

just a minor thing, but that way we could remove the OR operator on line 70 :)

const tagListName = lodashGet(tagList, 'name', translate('common.tag'));

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I applied this refactor in the PR I have opened!

shouldEnableMaxHeight
>
<HeaderWithBackButton
title={tagListName || translate('common.tag')}
Copy link
Contributor

Choose a reason for hiding this comment

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

if the tagListName had a default of translate('common.tag') than titleparam value could be justtagListName`. See above

@@ -544,6 +546,7 @@ export default {
`changed the ${valueName} to ${newValueToDisplay} (previously ${oldValueToDisplay})`,
threadRequestReportName: ({formattedAmount, comment}: ThreadRequestReportNameParams) => `${formattedAmount} request${comment ? ` for ${comment}` : ''}`,
threadSentMoneyReportName: ({formattedAmount, comment}: ThreadSentMoneyReportNameParams) => `${formattedAmount} sent${comment ? ` for ${comment}` : ''}`,
tagSelection: ({tagName}: TagSelectionParams) => `Select a ${tagName} to add additional organization to your money`,
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this copy was checked? It does not really read like a proper English sentence. We're going to create an issue to modify it.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's the copy that was in the mocks in the design doc, but yeah I am not sure if it was run through marketing prior to landing in the mocks (I did not run it through after, that much I know 😅). I agree it's a bit awkward wording and could be improved.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fixed here: #38242

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.

9 participants