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 Adding/Viewing tag on a Split Bill #31647

Merged
merged 17 commits into from
Dec 1, 2023

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Nov 21, 2023

Details

The PR introduces tags for split bills when a participant is a workspace. The app shows tags only for workspace participants with tags. All other cases users cannot add a tag to a split bill request. Also, we need to implement viewing a category on a newly created split bill.

Fixed Issues

$ #31631
PROPOSAL: N/A

Tests

Note: the backend is not ready yet to handle tags for split bills. So, we can check a newly added property in offline.

Note: "a workspace with some tags" means, that before testing, you should have a created workspace, which contains tags. For manipulating with tags, please use the OD. Also, the workspace's type should be "Collect" or "Control". If you cannot create your own, I can invite you to already prepared workspace.

1. Split bill with a tag

  1. Click on "+" (FAB).
  2. Click on "Request Money".
  3. Click on "Split" on a participant that is a workspace with some tags.
  4. Click on "Show more".
  5. Verify that there is "Tag" (or another name, based on your configuration) field.
  6. Click on the field.
  7. Verify that you can select/deselect a tag.
  8. Click on "Split".
  9. Verify that the app redirects you to a chat page with a newly created split bill.
  10. Verify that there is a tag field.
  11. Verify that the field is disabled, you cannot interact with it.

2. Split bill without a tag

  1. Click on "+" (FAB).
  2. Click on "Request Money".
  3. Click on "Split" on any participant that does not have tags like a regular user.
  4. Click on "Show more".
  5. Verify that there isn't "Tag" (or another name, based on your configuration) field.
  6. Click on "Split".
  7. Verify that the app redirects you to a chat page with a newly created split bill.
  8. Verify that there is a tag field.
  9. Verify that the field is disabled, you cannot interact with it.

3. Request money with a tag

  1. Click on "+" (FAB).
  2. Click on "Request Money".
  3. Click on a participant that is a workspace with some tags.
  4. Click on "Show more".
  5. Verify that there is "Tag" field.
  6. Click on "Request".
  7. Verify that the app redirects you to a chat page with a newly created money request.
  8. Verify that no errors happened.

4. Request money without a tag

  1. Click on "+" (FAB).
  2. Click on "Request Money".
  3. Click on any participant that does not have tags like a regular user.
  4. Click on "Show more".
  5. Verify that there isn't "Tag" field.
  6. Click on "Request".
  7. Verify that the app redirects you to a chat page with a newly created money request.
  8. Verify that no errors happened.
  • 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(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.

Screenshots/Videos

Android: Native
Android.mp4
Android: mWeb Chrome
Android.Chrome.mp4
iOS: Native
IOS.mp4
iOS: mWeb Safari
IOS.Safari.mp4
MacOS: Chrome / Safari Chrome Network
Chrome.mp4
MacOS: Desktop
Desktop.mp4

@rezkiy37 rezkiy37 changed the title Allow Adding/Viewinga tag on a Split Bill Allow Adding/Viewing tag on a Split Bill Nov 21, 2023
@rezkiy37
Copy link
Contributor Author

I've added one more case how to determine if a report is a policy expense chat - 5082a84. Because, a report can not have chatType.

No chatType

@rezkiy37 rezkiy37 marked this pull request as ready for review November 22, 2023 17:32
@rezkiy37 rezkiy37 requested a review from a team as a code owner November 22, 2023 17:32
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team November 22, 2023 17:32
Copy link

melvin-bot bot commented Nov 22, 2023

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

src/libs/ReportUtils.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
@cubuspl42
Copy link
Contributor

The code looks good, I left minor comments 👍

@cubuspl42
Copy link
Contributor

I'm testing

@cubuspl42
Copy link
Contributor

A silly question: what does it mean to have tags? I think that a setup of a test account that "has tags" could be a part of QA Steps / Tests

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Nov 28, 2023

A silly question: what does it mean to have tags? I think that a setup of a test account that "has tags" could be a part of QA Steps / Tests

I means that a workspace should have tags for testing the new functionality.

@cubuspl42
Copy link
Contributor

I misread this, I thought that this is a property of a user. Still, I'm not sure how to add tags to a workspace. Is it obvious?

@rezkiy37
Copy link
Contributor Author

I misread this, I thought that this is a property of a user. Still, I'm not sure how to add tags to a workspace. Is it obvious?

I can add you to a workspace where there are some tags.

@cubuspl42
Copy link
Contributor

@rezkiy37 Thank you. Account: cubuspl42.1+4@gmail.com. Does it require some permissions to add a tag?

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Nov 28, 2023

@cubuspl42, I've added you as an admin to a workspace called "Control Policy". No, it does not.

@cubuspl42
Copy link
Contributor

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
tags-in-split-bills-web.mp4
Mobile Web - Chrome
tags-in-split-bills-android-web-compressed.mp4
Mobile Web - Safari
tags-in-split-bills-ios-web.mp4
Desktop
iOS
Android
tags-in-split-bills-android-compressed.mp4

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

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

Will a QA person know how to find "participant that is a workspace and has tags."? I don't think this description is precise enough, as it is a new feature

I think we could provide steps for crafting such workspace for testing purposes

@rezkiy37
Copy link
Contributor Author

I agree, makes sense. I will clarify it 🙂

@rezkiy37
Copy link
Contributor Author

@cubuspl42, I've added this block. I hope it is clear now. WDYT?

Screenshot 2023-11-30 at 17 33 12

@cubuspl42
Copy link
Contributor

@rezkiy37 I was missing the fact that you need to use OldDot! Maybe for QA people it would be obvious. Thanks for adding this!

@melvin-bot melvin-bot bot requested a review from puneetlath December 1, 2023 10:31
@puneetlath puneetlath merged commit fc86789 into Expensify:main Dec 1, 2023
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 1, 2023

✋ 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

OSBotify commented Dec 5, 2023

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Dec 5, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 6, 2023

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 6, 2023

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

@@ -1290,10 +1255,10 @@ function splitBill(participants, currentUserLogin, currentUserAccountID, amount,
* @param {String} comment
* @param {String} currency
* @param {String} category
* @param {String} tag
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #34988
When creating the optimistic split transaction, we needed to pass the category & tag to buildOptimisticTransaction

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.

5 participants