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

Allow for multiple levels of tags on workspace #34983

Merged
merged 58 commits into from
Feb 15, 2024

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Jan 23, 2024

Details

The PR introduces a new logic for using multiple levels of tags. It supports for creating/editing requests with independent multi-level tags for paid workspaces.

Fixed Issues

$ #33983
PROPOSAL: N/A

Tests

Pre-condition:

  • Create/have a paid workspace (Collect/Control).
  • Enable a flag "Use multiple levels of tags" via OD.
  • You can import an attached collection of multiple levels of tags.

Apply tags for creating an expense report

  1. Open a workspace chat.
  2. Click on "+" (actions).
  3. Click on "Request money".
  4. Choose any type of an expense report: manual, scan and distance.
  5. Click on "Show more".
  6. Verify that a row rendered for each tag in the workspace after a category row.
  7. Apply any tags to the expense report.
  8. Verify that selection works for each row, and that the appropriate list of tags show for the appropriate level.
  9. Create the report.
  10. Open a report details page of this newly created report.
  11. Verify that all previously selected tags have been applied properly for the expense report.
  12. Try to create one more expense report.
  13. Verify that the previously tags have been added properly to recently used tags.

Apply tags for editing an expense report

  1. Open a report details page of an expense report.
  2. Verify that a row rendered for each tag in the workspace after a category row.
  3. Click on any tag field.
  4. Apply any tags to the expense report.
  5. Verify that a newly selected tag has been applied properly for the expense report.
  6. Try to create one more expense report.
  7. Verify that the previously tags have been added properly to recently used tags.

Apply tags for a split bill

  1. Open a workspace chat.
  2. Click on "+" (actions).
  3. Click on "Split bill".
  4. Choose any type of a split bill: manual, scan and distance.
  5. Click on "Show more".
  6. Verify that a row rendered for each tag in the workspace after a category row.
  7. Apply any tags to the split bill.
  8. Verify that selection works for each row, and that the appropriate list of tags show for the appropriate level.
  9. Create the report.
  10. Open a split bill details page of this newly created split bill.
  11. Verify that all previously selected tags have been applied properly for the split bill.
  12. Try to create one more expense report.
  13. Verify that the previously tags have been added properly to recently used tags.
  • Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android.1.mp4
Android.2.mp4
Android.3.mp4
Android: mWeb Chrome
Android.Chrome.1.2.mp4
Android.Chrome.3.mp4
iOS: Native
IOS.1.mp4
IOS.2.mp4
IOS.3.mp4
iOS: mWeb Safari
IOS.Safari.1.mp4
IOS.Safari.2.mp4
IOS.Safari.3.mp4
MacOS: Chrome / Safari
Chrome.1.mp4
Chrome.2.mp4
Chrome 2 Distance Chrome 2 Receipt
Chrome.3.mp4
MacOS: Desktop
Desktop.1.mp4
Desktop.2.mp4
Desktop.3.mp4

@rezkiy37
Copy link
Contributor Author

Resolved the conflicts.

@yuwenmemon
Copy link
Contributor

yuwenmemon commented Feb 14, 2024

@rezkiy37 more conflicts and now there's a typescript error :(

Feel free to ping me on Slack when you resolve and hopefully, I can just review/merge right away.

@yuwenmemon yuwenmemon merged commit 2fe384c into Expensify:main Feb 15, 2024
15 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/yuwenmemon in version: 1.4.43-0 🚀

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

Comment on lines +86 to +88
data: {
tagName: key,
},
Copy link
Contributor

@cead22 cead22 Feb 20, 2024

Choose a reason for hiding this comment

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

This broke the client side violation logic for tags -- I'm fixing it. Why did we add {data { tagName }} here, and why did we add userMessage?

Update data.tagName is necessary to show violations where the tag list name has a custom name, eg, Missing Department

Update 2 it looks like userMessage was already there when this PR was implemented

@pecanoro
Copy link
Contributor

It seems this PR caused this regression here: #36889. @cead22 Are you fixing it in this PR #36821?

@cead22
Copy link
Contributor

cead22 commented Feb 20, 2024

It's being fixed here #36919

@pecanoro
Copy link
Contributor

@cead22 That seems a totally different deploy blocker 😄

@pecanoro
Copy link
Contributor

I think you are fixing it here since it mentions the tag violation is not showing.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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

function getTagListName(policyTags: OnyxEntry<PolicyTags>) {
if (Object.keys(policyTags ?? {})?.length === 0) {
return '';
function getTagLists(policyTagList: OnyxEntry<PolicyTagList>): Array<PolicyTagList[keyof PolicyTagList]> {
Copy link
Contributor

Choose a reason for hiding this comment

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

Heads up that using indexed types in this manner goes against our TS style guidelines.

Instead of PolicyTagList[keyof PolicyTagList], we should use the much more readable ValueOf utility from type-fest:

function getTagLists(policyTagList: OnyxEntry<PolicyTagList>): Array<ValueOf<PolicyTagList>> {

I'm tempted to create an issue to create a lint rule to enforce this and automatically update it via Prettier, but we have more urgent matters at hand.

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 for this comment. I will use ValueOf next time 🙂

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.

8 participants