[GL] Tax - Add tax code by rushatgabhane · Pull Request #43156 · Expensify/App

rushatgabhane · 2024-06-06T02:02:01Z

Details

Fixed Issues

$ #44258
PROPOSAL:

Tests

Go to a control policy
Go to taxes page
Tap a tax rate
Verify that you can see tax code
Edit the tax code and save
Verify that the tax code is edited and saved

[] Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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

Screen.Recording.2024-07-13.at.01.11.42.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-07-10.at.00.00.23.mov

MacOS: Desktop

Screen.Recording.2024-07-13.at.01.33.27.mov

Gonals · 2024-07-09T13:49:53Z

@rushatgabhane, is it possible to test with this one yet?

rushatgabhane · 2024-07-15T10:55:28Z

@mollfpr looking forward to your review

mollfpr · 2024-07-15T11:18:57Z

Review and test it now!

mollfpr

Looks good!

Just an issue left. We can randomly change the taxID and submit the form but it return the not found page.

We can check the tax rate if it's available then return not found page in WorkspaceTaxCodePage. Similar to WorkspaceEditTaxPage.

Screen.Recording.2024-07-15.at.19.16.41.mp4

rushatgabhane · 2024-07-15T13:56:48Z

We can check the tax rate if it's available then return not found page in WorkspaceTaxCodePage. Similar to WorkspaceEditTaxPage.

That seems unnecessary to me. It's not going to happen for any user, right? @Gonals should we fix this?

dangrous

I didn't look fully through this yet but noticed this issue with the Onyx data and wanted to call that out first!

src/libs/ValidationUtils.ts

Gonals · 2024-07-16T04:55:27Z

We can check the tax rate if it's available then return not found page in WorkspaceTaxCodePage. Similar to WorkspaceEditTaxPage.

That seems unnecessary to me. It's not going to happen for any user, right? @Gonals should we fix this?

I think the current behavior is fine 🤷

mollfpr · 2024-07-16T13:16:57Z

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

43156.Android.mp4

43156.Android.-.Offline.mp4

Android: mWeb Chrome

43156.mWeb-Chrome.mp4

43156.mWeb-Chrome.-.Offline.mp4

iOS: Native

43156.iOS.mov

43156.iOS.-.Offline.mov

iOS: mWeb Safari

43156.mWeb-Safari.mov

43156.mWeb-Safari.-.Offline.mov

MacOS: Chrome / Safari

43156.Web.mp4

43156.Web.-.Offline.mp4

MacOS: Desktop

43156.Desktop.mp4

43156.Desktop.-.Offline.mp4

dylanexpensify · 2024-07-16T16:41:48Z

@mollfpr can we please prioritize this one?

mollfpr

LGTM 👍

dangrous

A couple NABs but looks good to me! Will wait for @Gonals for final merge

dangrous · 2024-07-16T17:57:33Z

src/libs/actions/TaxRate.ts

+                                pendingFields: {code: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE},
+                                pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
+                                errorFields: {code: null},
+                                previousTaxCode: oldTaxCode,


NAB - are we using this anywhere? not sure we need it

yes, if the action fails then we need to reset the taxCode. The previousTaxCode will be used for it

dangrous · 2024-07-16T17:57:41Z

src/libs/actions/TaxRate.ts

+                            [oldTaxCode]: null,
+                            [newTaxCode]: {
+                                ...originalTaxRate,
+                                code: newTaxCode,


Same here - do we need this?

im using it for pending fields and showing errors. we need a key inside the object for which an error or pending action can be associated

https://github.com/Expensify/App/pull/43156/files/81bc5b0bc03d1cbf731a4ab2de1e1968e0aef781#diff-008bfc3488a59780cc0f301b91072fc1e18513a7bca89cb81b883772a76275a5R128

ah right, thanks!

OSBotify · 2024-07-17T16:28:36Z

✋ 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 · 2024-07-18T14:12:18Z

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.9-1 🚀

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

OSBotify · 2024-07-19T11:54:59Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.9-2 🚀

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 · 2024-07-19T19:35:53Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

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

OSBotify · 2024-07-23T08:02:07Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

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

fedirjh · 2024-08-08T11:16:45Z

src/pages/workspace/taxes/WorkspaceTaxCodePage.tsx

+            Navigation.dismissModal();
+            Navigation.navigate(ROUTES.WORKSPACE_TAX_EDIT.getRoute(policyID, newTaxCode));


Dismissing the modal has caused a blinking bug in #45684, we should have used Navigation.goBack to fix that bug.

rushatgabhane added 9 commits June 6, 2024 04:49

add glcode route

5d711c4

add glcode screen const

f66b22b

add lang

9b1b630

rename to taxcode

8703337

add api params

235158b

add api params

6e9009b

add api types for tax code

02e0428

add tax code to rhp

093711b

add tax code type for navigation

d3f86b7

rushatgabhane changed the title ~~Tax - Add tax code~~ [GL] Tax - Add tax code Jun 7, 2024

rushatgabhane mentioned this pull request Jul 8, 2024

[Detailed Portion] Add GL/Payroll/Tax Codes to NewDot #43028

Closed

4 tasks

rushatgabhane added 6 commits July 9, 2024 16:15

add access variant for control policy

1eca1e1

fix merge

da57f9e

fix api params for taxcode

d046fe0

fix lang

ed414d7

add tax code

451548c

add menu item for taxcode

a69ff83

rushatgabhane added 9 commits July 9, 2024 17:32

add tax type to onyx forms

1131d5d

fix form id

f782d3f

add setpolicy tax code onyx method

bee9d44

add prev tax code

6dedec2

fix types

69ddb27

add tax code validation and make form working

2c17a1f

handle tax code navigation

78a4aeb

go back

5d00b9f

fix navigation

7336fa1

rushatgabhane marked this pull request as ready for review July 9, 2024 21:03

rushatgabhane requested a review from a team as a code owner July 9, 2024 21:03

melvin-bot bot removed the request for review from a team July 9, 2024 21:03

rushatgabhane added 2 commits July 15, 2024 13:49

fix translation

62f5256

add taxid to param

07067a6

rushatgabhane requested a review from Gonals July 15, 2024 10:54

mollfpr reviewed Jul 15, 2024

View reviewed changes

dangrous requested changes Jul 15, 2024

View reviewed changes

src/libs/ValidationUtils.ts Outdated Show resolved Hide resolved

rushatgabhane added 2 commits July 16, 2024 05:03

Merge branch 'main' of github.com:rushatgabhane/exfy into gl-code-taxes

04f31e0

correct logic for existing tax code

81bc5b0

rushatgabhane requested a review from mollfpr July 16, 2024 02:54

mollfpr approved these changes Jul 16, 2024

View reviewed changes

dangrous approved these changes Jul 16, 2024

View reviewed changes

Merge branch 'main' of github.com:rushatgabhane/exfy into gl-code-taxes

a78d2b5

dangrous merged commit da6c35b into Expensify:main Jul 17, 2024

github-actions bot mentioned this pull request Jul 18, 2024

Deploy Checklist: New Expensify 2024-07-18 #45680

Closed

61 tasks

melvin-bot bot mentioned this pull request Jul 19, 2024

[CHECKLIST][HOLD for payment 2024-07-26] Tax - Add tax code #44258

Closed

daledah mentioned this pull request Jul 22, 2024

[HOLD for payment 2024-09-09][$250] Track tax - Tax rate is no longer assigned to the distance rate after changing the tax code #45861

Closed

6 tasks

etCoderDysto mentioned this pull request Jul 22, 2024

[$250] Tax - Toggle becomes unlocked, Delete button appears briefly after saving tax code of default rate #45858

Closed

6 tasks

fedirjh reviewed Aug 8, 2024

View reviewed changes

fedirjh mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-08-07] [$250] Taxes - App blinks after saving tax code #45684

Closed

6 tasks

c3024 mentioned this pull request Sep 8, 2024

[HOLD for payment 2024-09-07] [$250] Taxes - Name field is no longer grayed out after editing tax code offline #47747

Closed

6 tasks

		Navigation.dismissModal();
		Navigation.navigate(ROUTES.WORKSPACE_TAX_EDIT.getRoute(policyID, newTaxCode));

Conversation

rushatgabhane commented Jun 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Gonals commented Jul 9, 2024

Uh oh!

rushatgabhane commented Jul 15, 2024

Uh oh!

mollfpr commented Jul 15, 2024

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Jul 15, 2024

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Gonals commented Jul 16, 2024

Uh oh!

mollfpr commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dylanexpensify commented Jul 16, 2024

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

dangrous Jul 16, 2024

Choose a reason for hiding this comment

Uh oh!

rushatgabhane Jul 16, 2024

Choose a reason for hiding this comment

Uh oh!

dangrous Jul 16, 2024

Choose a reason for hiding this comment

Uh oh!

rushatgabhane Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dangrous Jul 17, 2024

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jul 17, 2024

Uh oh!

OSBotify commented Jul 18, 2024

Uh oh!

OSBotify commented Jul 19, 2024

Uh oh!

OSBotify commented Jul 19, 2024

Uh oh!

OSBotify commented Jul 23, 2024

Uh oh!

fedirjh Aug 8, 2024

Choose a reason for hiding this comment

Uh oh!

dangrous Aug 8, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

rushatgabhane commented Jun 6, 2024 •

edited

Loading

mollfpr commented Jul 16, 2024 •

edited

Loading

rushatgabhane Jul 16, 2024 •

edited

Loading