[No QA] [TS Migration] Migrate PaymentMethods.js to TypeScript by JKobrynski · Pull Request #29074 · Expensify/App

JKobrynski · 2023-10-09T09:59:06Z

Details

Fixed Issues

$ #24911
PROPOSAL: N/A

Tests

Go to the wallet page
Make sure there are no errors and everything looks like it used to

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

src/types/onyx/AccountData.ts

rezkiy37

Left a comment. In general, LGTM.

src/libs/actions/PaymentMethods.ts

kubabutkiewicz · 2023-10-10T12:22:13Z

@JKobrynski one more thing, please add return types to functions as its our convention, besides that LGTM 👍

src/types/onyx/AccountData.ts

blazejkustra · 2023-10-11T09:57:37Z

src/libs/actions/PaymentMethods.ts

+
+type PaymentCardParams = {expirationDate: string; cardNumber: string; securityCode: string; nameOnCard: string; addressZipCode: string};
+
+type FilterMethodPaymentType = typeof CONST.PAYMENT_METHODS.DEBIT_CARD | typeof CONST.PAYMENT_METHODS.BANK_ACCOUNT | null;


Let's define it in src/types/onyx/WalletTransfer file and import it here

src/libs/actions/PaymentMethods.ts

blazejkustra · 2023-10-11T10:09:11Z

src/libs/actions/PaymentMethods.ts

    return onyxData;
 }

+type MakeDefaultPaymentMethodParams = {


You can move params type to function body (examples in Fabio's PR)

context:

Thanks, updated

src/libs/actions/PaymentMethods.ts

blazejkustra · 2023-10-11T10:09:25Z

src/libs/actions/PaymentMethods.ts

    });
 }

+type TransferWalletBalanceParameters = Partial<Record<ValueOf<typeof CONST.PAYMENT_METHOD_ID_KEYS>, number | undefined>>;


You can move params type to function body (examples in Fabio's PR)

src/libs/actions/PaymentMethods.ts

JKobrynski · 2023-10-12T08:26:57Z

@blazejkustra PR updated, feel free to take another look 😄

melvin-bot · 2023-10-16T14:21:34Z

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

srikarparsi · 2023-10-16T18:16:31Z

Hi @JKobrynski, looks like there's a conflict, also could you please include the testing steps in the original description?

JKobrynski · 2023-10-17T07:44:24Z

@srikarparsi done!

srikarparsi · 2023-10-17T17:33:55Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

srikarparsi

lgtm!

OSBotify · 2023-10-18T01:58:15Z

✋ 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 · 2023-10-19T00:33:52Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.87-0 🚀

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

OSBotify · 2023-10-19T00:59:33Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.87-0 🚀

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

bondydaa · 2023-10-20T15:28:16Z

it looks like this may have caused a regression here #30024, could someone help confirm? #30024 (comment)

OSBotify · 2023-10-20T21:08:37Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.87-12 🚀

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

OSBotify · 2023-10-20T21:41:12Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.88-0 🚀

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

OSBotify · 2023-10-23T04:53:24Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

parasharrajat · 2023-11-06T17:33:05Z

src/libs/actions/PaymentMethods.ts

+    Onyx.set(ONYXKEYS.FORMS.ADD_DEBIT_CARD_FORM, {
+        isLoading: false,
+        errors: undefined,
+        setupComplete: true,


Changing the default value caused #30024

JKobrynski added 5 commits October 6, 2023 09:25

export missing types

2acb97a

migrate PaymentMethods to TypeScript

c0a69bc

Merge branch 'main' into migratePaymentMethodsToTypeScript

c4e692e

add missing fields to types, fix type errors

7d30ece

remove unnecessary comments, apply minor fixes

66030eb

rezkiy37 reviewed Oct 9, 2023

View reviewed changes

src/types/onyx/AccountData.ts Show resolved Hide resolved

rezkiy37 reviewed Oct 9, 2023

View reviewed changes

VickyStash reviewed Oct 9, 2023

View reviewed changes

src/libs/actions/PaymentMethods.ts Outdated Show resolved Hide resolved

src/libs/actions/PaymentMethods.ts Outdated Show resolved Hide resolved

src/libs/actions/PaymentMethods.ts Outdated Show resolved Hide resolved

kubabutkiewicz reviewed Oct 9, 2023

View reviewed changes

src/libs/actions/PaymentMethods.ts Show resolved Hide resolved

src/libs/actions/PaymentMethods.ts Outdated Show resolved Hide resolved

src/libs/actions/PaymentMethods.ts Outdated Show resolved Hide resolved

JKobrynski added 3 commits October 9, 2023 16:42

extract types, fix minor issues

6a2dec0

type API parameters

7369a5c

use OnyxUpdate type

29e42f7

kubabutkiewicz approved these changes Oct 10, 2023

View reviewed changes

bring back missing onyx key

a7c9065

blazejkustra suggested changes Oct 11, 2023

View reviewed changes

JKobrynski added 2 commits October 12, 2023 09:30

apply suggested changes

439d2ec

type API data, prevent dependency cycle

0485702

JKobrynski requested a review from blazejkustra October 12, 2023 08:27

blazejkustra approved these changes Oct 13, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review October 16, 2023 14:20

JKobrynski requested a review from a team as a code owner October 16, 2023 14:20

JKobrynski mentioned this pull request Oct 16, 2023

[TS migration] Migrate 'PaymentMethods.js' lib to TypeScript #24911

Closed

melvin-bot bot requested review from srikarparsi and removed request for a team October 16, 2023 14:21

Merge branch 'main' into migratePaymentMethodsToTypeScript

9f0956a

srikarparsi approved these changes Oct 18, 2023

View reviewed changes

srikarparsi merged commit f626744 into Expensify:main Oct 18, 2023

OSBotify mentioned this pull request Oct 18, 2023

Deploy Checklist: New Expensify 2023-10-18 #29926

Closed

64 tasks

Pujan92 mentioned this pull request Oct 20, 2023

[HOLD for payment 2023-11-09] [$500] Wallet - Once after login, debit card page exits without open #30024

Closed

6 tasks

OSBotify mentioned this pull request Oct 20, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

parasharrajat reviewed Nov 6, 2023

View reviewed changes


		type PaymentCardParams = {expirationDate: string; cardNumber: string; securityCode: string; nameOnCard: string; addressZipCode: string};

		type FilterMethodPaymentType = typeof CONST.PAYMENT_METHODS.DEBIT_CARD \| typeof CONST.PAYMENT_METHODS.BANK_ACCOUNT \| null;

Conversation

JKobrynski commented Oct 9, 2023 • 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!

Uh oh!

rezkiy37 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kubabutkiewicz commented Oct 10, 2023

Uh oh!

Uh oh!

blazejkustra Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

JKobrynski Oct 12, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

blazejkustra Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

JKobrynski Oct 12, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

blazejkustra Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JKobrynski commented Oct 12, 2023

Uh oh!

melvin-bot bot commented Oct 16, 2023

Uh oh!

srikarparsi commented Oct 16, 2023

Uh oh!

JKobrynski commented Oct 17, 2023

Uh oh!

srikarparsi commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

srikarparsi left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 18, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

bondydaa commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

parasharrajat Nov 6, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

JKobrynski commented Oct 9, 2023 •

edited

Loading

srikarparsi commented Oct 17, 2023 •

edited

Loading