[Taxes] Display tax rate value in the list

[kosmydel]

Details

This PR adds:

• displaying tax rate value in the Taxes list in settings,
• reactors the dot separator to use the const.

Fixed Issues

$ #40024
PROPOSAL: N/A

Tests

• Tests from the QA section
• Check thoroughly if the dot separators are correctly changed to the const.

Offline tests

N/A

QA Steps

Test the Taxes

1. Go to the Collect Workspace -> Taxes (enable it in More Features if needed).
2. Verify the value is displayed for each tax.
3. Change the default workspace/foreign currency:
   1. To two different tax rates.
   2. Set both defaults (foreign and workspace) to the same tax rate, and verify the Default label is displayed.
4. Add new taxes and verify the value is displayed.
5. Edit the tax value.

Test new dot separator

1. Request money with Global FAB
2. Generate a Distance money request
3. Go to next step and select a Collect workspace as participant.
4. In the Money Request confirmation list, verify that the default tax name is displayed with • (Test 1)
5. Go back to LHN page
6. Select any settled Expense report and go to the Expense Details Page.
7. Verify that the details show with Amount • Cash • Paid (Test 2)
8. Select a Collect workspace by going to LHN -> Settings -> Workspaces
9. Select Taxes settings and verify that the additional text for each tax rate displays tax rate value as prefix in the taxes page.
   Further, if this is the default tax rate, additionally verify that • followed by the default text is displayed. (Test 3)

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

[melvin-bot]

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

[shawnborton]

We use this in other places too for preview cards, etc. Just wondering if we can check how we're implementing it elsewhere, and try to consolidate so we don't have multiple ways of implementing this?

[kosmydel]

I've checked it. We use it just in line. I thought, that it would be nice to have it as a constant. But if needed, I can adjust my solution to also use it inline.

Example (MoneyRequestPreviewContent.tsx):

[shawnborton]

I like using it as a constant, and it would be nice if the other places followed this same approach as well :)

[kosmydel]

Hm, I think I can change it. Do you want me to change it in this PR or create a new one?

[shawnborton]

Follow up is totally fine with me, I don't feel too strongly.

[rojiphil]

We use this in other places too for preview cards, etc. Just wondering if we can check how we're implementing it elsewhere, and try to consolidate so we don't have multiple ways of implementing this?

@shawnborton Forgive my ignorance here as I do not understand - other places too for preview cards. Can you please point out exactly where you referred to in the FE?

However, I do see usage of DOT_SEPARATOR for taxes in the money request flow as shown below. That way, we do not have multiple ways of implementing this.

[kosmydel]

I've replaced this character to use the const everywhere except for the maskCard function, as it is used in different contexts (not as a separator, but as a mask).

[shawnborton]

Ah I mostly meant that we also use it in places like the expenses detail view:

As well as report previews:

[shawnborton]

So we should make sure we test those locations as part of the testing steps and screenshots, just to make sure our changes here don't mess anything up. Thanks!

[kosmydel]

I've updated the test sections with the report view. I'm not sure if I will be able to find steps for all the cases.

[rojiphil]

@kosmydel Additionally, I think we can use DOT_SEPARATOR here and here too as we construct the default tax names using DOT_SEPARATOR. Does this make sense?

[rojiphil]

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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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(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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Note: Could not test on Android due to some local setup issues. NAB to me as this issue is not platform dependent.

Android: mWeb Chrome

40024-mweb-chrome.mp4

iOS: Native

40024-ios-native.mp4

iOS: mWeb Safari

40024-mweb-safari.mp4

MacOS: Chrome / Safari

40024-web-safari.mp4

MacOS: Desktop

40024-desktop.mp4

[kosmydel]

I was AFK for a moment, will change it in ~1 hour.

[kosmydel]

Done. Ready for review.

[rojiphil]

@kosmydel There is a lint error due to a prettier diff. Can you please resolve this?
And further, adding test cases and relevant screenshots would help us clear the checklist.

[kosmydel]

Ready! I've run the prettier and added more testing steps.

[rojiphil]

@kosmydel, The following test steps seems more clear for testing the new dot separator. I used these steps to capture the test video. It would be good if you could include these steps in the checklist for QA’s reference.

Test new dot separator
1 Request money with Global FAB
2 Generate a Distance money request
3 Go to next step and select a Collect workspace as participant.
4 In the Money Request confirmation list, verify that the default tax name is displayed with • (Test 1)
5 Go back to LHN page
6 Select any settled Expense report and go to the Expense Details Page.
7 Verify that the details show with Amount • Cash • Paid (Test 2)
8 Select a Collect workspace by going to LHN -> Settings -> Workspaces
9 Select Taxes settings and verify that the additional text for each tax rate displays tax rate value as prefix in the taxes page. Further, if this is the default tax rate, additionally verify that • followed by the default text is displayed. (Test 3)

[rojiphil]

Thanks @kosmydel. LGTM

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #40024 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[melvin-bot]

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

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

[dangrous]

@neil-marcellini it looks like you're assigned to the issue so I'll let you have first crack at review. If you want another set of eyes, though, let me know!

[neil-marcellini]

I'm going to wait to review until after the C+ approves for efficiency

edit: Oh my bad, I see that they recently approved

[neil-marcellini]

Looks great thanks!

[OSBotify]

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.4.63-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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