[TS migration] Migrate IOURequestStepTaxRatePage and IOURequestStepTaxAmountPage to TypeScript by SzymczakJ · Pull Request #39059 · Expensify/App

SzymczakJ · 2024-03-27T13:58:12Z

Details

Fixed Issues

$ #38915
PROPOSAL:

Tests

To test this feature you have to have tax enabled on your Collect policy, this is how you can create it so it works in NewDot:

make manual/scan money request and try check tax rate and tax amount sections.
try to change tax rate type
try to change tax amount

Offline tests

QA Steps

Same as Tests

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

Android: mWeb Chrome

androidweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

blazejkustra · 2024-03-27T15:19:43Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

+type IOURequestStepTaxAmountPageProps = {
+    transaction: OnyxEntry<Transaction>;
+} & IOURequestStepTaxAmountPageOnyxProps &
+    WithWritableReportOrNotFoundProps;


Nit:

Suggested change

type IOURequestStepTaxAmountPageProps = {

transaction: OnyxEntry<Transaction>;

} & IOURequestStepTaxAmountPageOnyxProps &

WithWritableReportOrNotFoundProps;

type IOURequestStepTaxAmountPageProps = IOURequestStepTaxAmountPageOnyxProps & WithWritableReportOrNotFoundProps & {

transaction: OnyxEntry<Transaction>;

};

blazejkustra · 2024-03-27T15:20:05Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

+} & IOURequestStepTaxAmountPageOnyxProps &
+    WithWritableReportOrNotFoundProps;
+
+const getTaxAmount = (transaction: OnyxEntry<Transaction>, defaultTaxValue: string | undefined) => {


Nit: transform to named function

Also add a return type here

blazejkustra · 2024-03-27T15:21:38Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

    };

-    const updateTaxAmount = (currentAmount) => {
+    const updateTaxAmount = (currentAmount: {amount: string}) => {


Extract this inline type to a separate line

blazejkustra · 2024-03-27T15:22:01Z

src/pages/iou/request/step/IOURequestStepTaxRatePage.tsx

+type IOURequestStepTaxRatePageProps = {
+    transaction: OnyxEntry<Transaction>;
+} & IOURequestStepTaxRatePageOnyxProps &
+    WithWritableReportOrNotFoundProps;


Same here:

type IOURequestStepTaxRatePageProps = IOURequestStepTaxRatePageOnyxProps & WithWritableReportOrNotFoundProps & { transaction: OnyxEntry<Transaction>; };

blazejkustra · 2024-03-27T15:22:21Z

src/pages/iou/request/step/IOURequestStepTaxRatePage.tsx

+} & IOURequestStepTaxRatePageOnyxProps &
+    WithWritableReportOrNotFoundProps;
+
+const getTaxAmount = (taxRates: TaxRatesWithDefault, selectedTaxRate: string, amount: number) => {


Add a return type + transform to a named function

blazejkustra · 2024-03-27T15:24:18Z

src/pages/iou/request/step/IOURequestStepTaxRatePage.tsx

+type IOURequestStepTaxRatePageProps = {
+    transaction: OnyxEntry<Transaction>;
+} & IOURequestStepTaxRatePageOnyxProps &
+    WithWritableReportOrNotFoundProps;


Do the same change as Marcin did here

blazejkustra · 2024-03-28T12:02:14Z

src/libs/Navigation/types.ts

        transactionID: string;
        reportID: string;
-        backTo: string;
+        backTo: Routes | undefined;


Should this be | undefined or an optional property?

fabioh8010 · 2024-03-28T20:07:48Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

+    if (!transaction?.amount) {
+        return;
+    }
+    const percentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';


Suggested change

const percentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';

const percentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';

fabioh8010 · 2024-03-28T20:08:32Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

-        } else {
-            originalCurrency.current = currency;
-            IOU.setMoneyRequestOriginalCurrency_temporaryForRefactor(transactionID, currency);
+        } else if (transaction?.currency) {


make sure this change won't create regressions

fabioh8010 · 2024-03-28T20:08:42Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

        }
        return () => {
-            if (isSaveButtonPressed.current) {
+            if (isSaveButtonPressed.current || !originalCurrency.current) {


kubabutkiewicz · 2024-03-29T09:30:42Z

@SzymczakJ can you make this PR as ready to review?

melvin-bot · 2024-03-29T09:33:33Z

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

jjcoffee · 2024-04-01T10:56:16Z

Reviewing tomorrow!

jjcoffee · 2024-04-02T12:28:11Z

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

android-app-2024-04-02_15.45.52.mp4

Android: mWeb Chrome

android-chrome-2024-04-02_15.30.52.mp4

iOS: Native

ios-app-2024-04-02_16.08.00.mp4

iOS: mWeb Safari

ios-safari-2024-04-02_16.01.18.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-04-02_14.40.39.mp4

MacOS: Desktop

desktop-app-2024-04-02_15.17.33.mp4

jjcoffee · 2024-04-02T13:43:22Z

@SzymczakJ Could you add the recording for Mac OS: Desktop?

SzymczakJ · 2024-04-02T13:52:16Z

@jjcoffee done!

jjcoffee

LGTM, tests well!

melvin-bot · 2024-04-02T14:11:09Z

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

jjcoffee

Re-approving to get an engineer assigned!

fabioh8010 · 2024-04-03T08:26:54Z

@SzymczakJ we have conflicts here

rlinoz · 2024-04-03T13:39:07Z

Looks good, just needs to resolve the conflicts.

SzymczakJ · 2024-04-04T13:09:16Z

@rlinoz resolved conflicts

OSBotify · 2024-04-04T13:28:30Z

✋ 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-04-08T11:08:44Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:05:22Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:22:59Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

shubham1206agra · 2024-06-07T10:49:50Z

src/pages/iou/request/step/IOURequestStepTaxAmountPage.tsx

+    if (!transaction?.amount) {
+        return;
+    }


This incomplete condition lead to this bug here #41434

SzymczakJ added 4 commits March 27, 2024 12:48

migrate IOURequestStepTaxRatePage

d024b90

migrate IOURequestStepTaxAmountPage

4afc028

fix missing report param

0ff4934

fix 0% tax value not selectable bug

3f56295

blazejkustra suggested changes Mar 27, 2024

View reviewed changes

SzymczakJ changed the title ~~{TS migration] Migrate IOURequestStepTaxRatePage and IOURequestStepTaxAmountPage to TypeScript~~ [TS migration] Migrate IOURequestStepTaxRatePage and IOURequestStepTaxAmountPage to TypeScript Mar 27, 2024

SzymczakJ added 2 commits March 27, 2024 17:26

fix PR comments

24bc418

fix type errors

c82e038

SzymczakJ requested a review from blazejkustra March 27, 2024 18:03

blazejkustra approved these changes Mar 28, 2024

View reviewed changes

fix pr comments

d8135d6

fabioh8010 approved these changes Mar 28, 2024

View reviewed changes

SzymczakJ marked this pull request as ready for review March 29, 2024 09:33

SzymczakJ requested a review from a team as a code owner March 29, 2024 09:33

melvin-bot bot requested review from jjcoffee and removed request for a team March 29, 2024 09:33

SzymczakJ added 3 commits April 2, 2024 12:51

Merge branch 'main' into @szymczak/TaxRequestPage+TaxAmmountPage

6b86683

fix type errors

3680708

Merge branch 'main' into @szymczak/TaxRequestPage+TaxAmmountPage

6a951eb

jjcoffee approved these changes Apr 2, 2024

View reviewed changes

melvin-bot bot requested a review from rlinoz April 2, 2024 14:12

jjcoffee mentioned this pull request Apr 2, 2024

[$250] [TS migration] Migrate IOURequestStepTaxRatePage and IOURequestStepTaxAmountPage pages to TypeScript #38915

Closed

merge main

8fa9894

SzymczakJ requested a review from a team as a code owner April 4, 2024 10:23

SzymczakJ added 2 commits April 4, 2024 12:30

fix tax rate step page bug

d104f3c

merge main

78ccb7b

shawnborton removed the request for review from a team April 4, 2024 12:30

fix typescript

38e9558

rlinoz approved these changes Apr 4, 2024

View reviewed changes

rlinoz merged commit 0b2f55f into Expensify:main Apr 4, 2024

github-actions bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

allgandalf mentioned this pull request Apr 8, 2024

[HOLD for payment 2024-04-25] Taxes - id_TAX_EXEMPT appears in the list when there are more than 8 tax rates #39825

Closed

6 tasks

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

shubham1206agra reviewed Jun 7, 2024

View reviewed changes

shubham1206agra mentioned this pull request Jun 7, 2024

[HOLD for payment 2024-06-05] [$250] [Track Tax] Unable to save tax amount which is below the limit for scan request #41434

Closed

6 tasks

SzymczakJ deleted the @szymczak/TaxRequestPage+TaxAmmountPage branch April 8, 2025 09:10

	const percentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';

	const percentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';

Conversation

SzymczakJ commented Mar 27, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz commented Mar 29, 2024

Uh oh!

melvin-bot bot commented Mar 29, 2024

Uh oh!

jjcoffee commented Apr 1, 2024

Uh oh!

jjcoffee commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

jjcoffee commented Apr 2, 2024

Uh oh!

SzymczakJ commented Apr 2, 2024

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Apr 2, 2024

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

fabioh8010 commented Apr 3, 2024

Uh oh!

rlinoz commented Apr 3, 2024

Uh oh!

SzymczakJ commented Apr 4, 2024

Uh oh!

OSBotify commented Apr 4, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

SzymczakJ commented Mar 27, 2024 •

edited

Loading

jjcoffee commented Apr 2, 2024 •

edited

Loading