[TS-migration] Migrate 'AddPaymentMethodMenu.tsx' to TypeScript #37900

mateuuszzzzz · 2024-03-07T15:39:22Z

Details

Fixed Issues

$ #25073
PROPOSAL:

Tests

Go to the wallet page (/settings/wallet route)
Click Add bank account button
Popover menu with available options should be visible.
Both options should be clickable.
Add debit card should show a component for entering debit card details.
Personal bank account should redirect to Plaid.

Offline tests

Repeat the Tests section and make sure it works the same with only one difference. Clicking on Personal bank account should display LHP with You appear to be offline. message.

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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.native.mov

Android: mWeb Chrome

Android.mWeb.mov

iOS: Native

iOS.native.mov

iOS: mWeb Safari

iOS.mweb.mov

MacOS: Chrome / Safari

macOS.browser.mov

MacOS: Desktop

macOS.desktop.mov

blazejkustra · 2024-03-14T11:35:36Z

src/components/AddPaymentMethodMenu.tsx

+    iouReport,
+    onItemSelected,
+    session,
+    shouldShowPersonalBankAccountOption = false,


How about rest default props like anchorAlignment?

blazejkustra · 2024-03-14T11:36:01Z

src/components/AddPaymentMethodMenu.tsx

+    isVisible: boolean;
+    onClose: () => void;
+    onItemSelected: (paymentMethod: ValueOf<typeof CONST.PAYMENT_METHODS>) => void;
+    iouReport?: OnyxEntry<Report>;
+    anchorPosition: AnchorPosition;
+    anchorAlignment?: AnchorAlignment;
+    anchorRef: RefObject<View | HTMLDivElement>;
+    shouldShowPersonalBankAccountOption?: boolean;


Missing JSDOc here 👀

blazejkustra · 2024-03-14T11:36:40Z

src/components/KYCWall/BaseKYCWall.tsx

@@ -246,7 +247,7 @@ function KYCWall({
        <>
            <AddPaymentMethodMenu
                isVisible={shouldShowAddPaymentMenu}
-                iouReport={iouReport}
+                iouReport={isEmptyObject(iouReport) ? undefined : iouReport}


Let's test this change 😄

github-actions · 2024-03-19T10:22:06Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

war-in · 2024-03-19T10:23:51Z

I have read the CLA Document and I hereby sign the CLA

war-in · 2024-03-19T10:43:28Z

All above comments are addressed (can't resolve them 🤷)

I've also tested updated BaseKYCWall component

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

VickyStash · 2024-03-19T11:24:58Z

src/components/KYCWall/BaseKYCWall.tsx

@@ -246,7 +247,7 @@ function KYCWall({
        <>
            <AddPaymentMethodMenu
                isVisible={shouldShowAddPaymentMenu}
-                iouReport={iouReport}
+                iouReport={isEmptyObject(iouReport) ? undefined : iouReport}


Maybe we can update iouReport type to include EmptyObject in the AddPaymentMethodMenu instead?

VickyStash · 2024-03-19T11:26:23Z

src/components/AddPaymentMethodMenu.tsx


    /** Callback to execute when the payment method is selected. */
-    onItemSelected: PropTypes.func.isRequired,
+    onItemSelected: (paymentMethod: ValueOf<typeof CONST.PAYMENT_METHODS>) => void;


You can reuse existing PaymentMethod type

Suggested change

onItemSelected: (paymentMethod: ValueOf<typeof CONST.PAYMENT_METHODS>) => void;

onItemSelected: (paymentMethod: PaymentMethod) => void;

melvin-bot · 2024-03-19T13:05:14Z

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

mananjadhav · 2024-03-20T16:05:50Z

Overall changes look good, are we going to address?

war-in · 2024-03-21T08:42:52Z

Overall changes look good, are we going to address?

@mananjadhav I believe I've addressed it here

mananjadhav · 2024-03-22T13:58:24Z

@war-in Can we add some content for the Offline Tests. For example, Add Debit card will load in offline but Plaid won't load.

mananjadhav · 2024-03-22T14:16:08Z

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-add-payment-menu.mov

Android: mWeb Chrome

mweb-chrome-add-payment-menu.mov

iOS: Native

ios-add-payment-menu.mov

iOS: mWeb Safari

mweb-safari-add-payment-menu.mov

MacOS: Chrome / Safari

web-add-payment-menu.mov

MacOS: Desktop

desktop-add-payment-menu.mov

mananjadhav

Change looks good and tests well. One last comment on offline test in the PR body. Can be merged after that.

melvin-bot · 2024-03-22T14:16:52Z

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

war-in · 2024-03-25T08:00:04Z

@war-in Can we add some content for the Offline Tests. For example, Add Debit card will load in offline but Plaid won't load.

Yes, we can :) One @mateuuszzzzz is back (I believe today) he will add it to the PR description (I don't have write permissions here)

blazejkustra · 2024-03-25T12:32:20Z

@MariaHCD Should we merge now, or we are waiting on something? 😄

MariaHCD · 2024-03-25T13:03:05Z

We're waiting on the offline tests to be added to the PR description :)

mateuuszzzzz · 2024-03-25T15:35:37Z

We're waiting on the offline tests to be added to the PR description :)

@MariaHCD I added offline tests

MariaHCD · 2024-03-26T06:08:06Z

Works as expected offline:

MariaHCD · 2024-03-26T06:57:11Z

The reassure performance test failed 🤔

🛑 Error while parsing file: .reassure/current.perf [
  {
    "code": "custom",
    "message": "Your performance result file contains records with duplicated names.\n    Please remove any non-unique names from your test suites and try again.",
    "path": []
  }
]
Error: Process completed with exit code 1.

Asked here: https://expensify.slack.com/archives/C05LX9D6E07/p1711436202175639

blazejkustra · 2024-03-26T09:40:55Z

@mateuuszzzzz @MariaHCD I merged the newest main, maybe this will fix it 😄

melvin-bot · 2024-03-26T10:13:21Z

@MariaHCD looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

MariaHCD · 2024-03-26T10:13:22Z

That did it, thanks!

https://expensify.slack.com/archives/C05LX9D6E07/p1711447946877659?thread_ts=1711436202.175639&cid=C05LX9D6E07

MariaHCD · 2024-03-26T10:14:27Z

Not an emergency, all tests passed

OSBotify · 2024-03-26T10:19:11Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Migrate AddPaymentMethodMenu.js to typescriptgpsup

9624b3b

blazejkustra suggested changes Mar 14, 2024

View reviewed changes

war-in added 2 commits March 19, 2024 09:25

add jsdoc comments and default values

8938eb1

Merge branch 'main' into ts/add-payment-method-menu

4ed812a

blazejkustra approved these changes Mar 19, 2024

View reviewed changes

Rerun

b2b840c

VickyStash reviewed Mar 19, 2024

View reviewed changes

apply suggestions

6d06a30

VickyStash approved these changes Mar 19, 2024

View reviewed changes

mateuuszzzzz marked this pull request as ready for review March 19, 2024 13:05

mateuuszzzzz requested a review from a team as a code owner March 19, 2024 13:05

melvin-bot bot removed the request for review from a team March 19, 2024 13:05

melvin-bot bot requested a review from mananjadhav March 19, 2024 13:05

mananjadhav approved these changes Mar 22, 2024

View reviewed changes

melvin-bot bot requested a review from MariaHCD March 22, 2024 14:17

MariaHCD approved these changes Mar 25, 2024

View reviewed changes

Merge branch 'main' into ts/add-payment-method-menu

844e3aa

MariaHCD merged commit a51e60e into Expensify:main Mar 26, 2024
20 of 21 checks passed

melvin-bot bot added the Emergency label Mar 26, 2024

MariaHCD removed the Emergency label Mar 26, 2024

MariaHCD mentioned this pull request Mar 26, 2024

[HOLD for payment 2024-04-02][TS migration] Migrate 'AddPaymentMethodMenu.js' component to TypeScript #25073

Closed

github-actions bot mentioned this pull request Mar 27, 2024

Deploy Checklist: New Expensify 2024-03-27 #39033

Closed

war-in deleted the ts/add-payment-method-menu branch June 24, 2024 09:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS-migration] Migrate 'AddPaymentMethodMenu.tsx' to TypeScript #37900

[TS-migration] Migrate 'AddPaymentMethodMenu.tsx' to TypeScript #37900

mateuuszzzzz commented Mar 7, 2024 •

edited

Loading

blazejkustra Mar 14, 2024

blazejkustra Mar 14, 2024

blazejkustra Mar 14, 2024

github-actions bot commented Mar 19, 2024 •

edited

Loading

war-in commented Mar 19, 2024

war-in commented Mar 19, 2024

VickyStash Mar 19, 2024

VickyStash Mar 19, 2024

melvin-bot bot commented Mar 19, 2024

mananjadhav commented Mar 20, 2024

war-in commented Mar 21, 2024 •

edited

Loading

mananjadhav commented Mar 22, 2024

mananjadhav commented Mar 22, 2024 •

edited by MariaHCD

Loading

mananjadhav left a comment

melvin-bot bot commented Mar 22, 2024

war-in commented Mar 25, 2024

blazejkustra commented Mar 25, 2024

MariaHCD commented Mar 25, 2024

mateuuszzzzz commented Mar 25, 2024

MariaHCD commented Mar 26, 2024

MariaHCD commented Mar 26, 2024

blazejkustra commented Mar 26, 2024

melvin-bot bot commented Mar 26, 2024

MariaHCD commented Mar 26, 2024 •

edited

Loading

MariaHCD commented Mar 26, 2024

OSBotify commented Mar 26, 2024

	onItemSelected: (paymentMethod: ValueOf<typeof CONST.PAYMENT_METHODS>) => void;
	onItemSelected: (paymentMethod: PaymentMethod) => void;

[TS-migration] Migrate 'AddPaymentMethodMenu.tsx' to TypeScript #37900

[TS-migration] Migrate 'AddPaymentMethodMenu.tsx' to TypeScript #37900

Conversation

mateuuszzzzz commented Mar 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra Mar 14, 2024

Choose a reason for hiding this comment

blazejkustra Mar 14, 2024

Choose a reason for hiding this comment

blazejkustra Mar 14, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 19, 2024 • edited Loading

war-in commented Mar 19, 2024

war-in commented Mar 19, 2024

Screenshots/Videos

VickyStash Mar 19, 2024

Choose a reason for hiding this comment

VickyStash Mar 19, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Mar 19, 2024

mananjadhav commented Mar 20, 2024

war-in commented Mar 21, 2024 • edited Loading

mananjadhav commented Mar 22, 2024

mananjadhav commented Mar 22, 2024 • edited by MariaHCD Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 22, 2024

war-in commented Mar 25, 2024

blazejkustra commented Mar 25, 2024

MariaHCD commented Mar 25, 2024

mateuuszzzzz commented Mar 25, 2024

MariaHCD commented Mar 26, 2024

MariaHCD commented Mar 26, 2024

blazejkustra commented Mar 26, 2024

melvin-bot bot commented Mar 26, 2024

MariaHCD commented Mar 26, 2024 • edited Loading

MariaHCD commented Mar 26, 2024

OSBotify commented Mar 26, 2024

mateuuszzzzz commented Mar 7, 2024 •

edited

Loading

github-actions bot commented Mar 19, 2024 •

edited

Loading

war-in commented Mar 21, 2024 •

edited

Loading

mananjadhav commented Mar 22, 2024 •

edited by MariaHCD

Loading

MariaHCD commented Mar 26, 2024 •

edited

Loading