[TS migration] Migrate 'Wallet.js' lib to TypeScript by BartoszGrajdek · Pull Request #30248 · Expensify/App

BartoszGrajdek · 2023-10-24T12:45:40Z

Details

Migrate 'Wallet.js' lib file to TypeScript

Fixed Issues

$ #24840

Tests

Preconditions: The user must not have enabled the wallet yet and must have no payment method.

Go to Settings
Go to Wallet
Press 'Add payment method'
Press 'Bank account'
Add the 'Plaid Checking' or 'Plaid Saving' bank account
Verify an 'Enable wallet' button is present in the wallet page
Press the 'Enable wallet' button
Verify the user is navigated to a page requesting additional details to be provided
Successfully complete the steps
Verify you are navigated back to the 'Wallet' page
Verify the wallet page does not show an 'Enable wallet' button, but instead a link stating 'Transfer balance'

Verify that no errors appear in the JS console

Offline tests

Preconditions: The user must not have enabled the wallet yet but must have added a payment method.

Go to Settings
Go to Wallet
Verify an 'Enable wallet' button is present in the wallet page
Verify the button is disabled

QA Steps

Preconditions: The user must not have enabled the wallet yet and must have no payment method.

Go to Settings
Go to Wallet
Press 'Add payment method'
Press 'Bank account'
Add the 'Plaid Checking' or 'Plaid Saving' bank account
Verify an 'Enable wallet' button is present in the wallet page
Press the 'Enable wallet' button
Verify the user is navigated to a page requesting additional details to be provided

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web-2.mov

Mobile Web - Chrome

chrome-2.mov

Mobile Web - Safari

safari-2.mov

Desktop

desktop-2.mov

iOS

ios-2.mov

Android

android-2.mov

blazejkustra

Different names for parameters are used across Wallet.ts, requestParams and parameters. It's better to stick with one name, not a blocker though!

kubabutkiewicz · 2023-11-02T14:38:07Z

+    addressZip?: string;
+    dob?: string;
+    ssn?: string;
+};


maybe we can move this type to the top of the file to be consistent with other files, and also maybe should we name it diffrently as its the same name as we have in Onyx ?

@kubabutkiewicz @BartoszGrajdek check my comment above.

fabioh8010

@BartoszGrajdek I did some additional review here 🙂

fabioh8010 · 2023-11-13T07:56:54Z

+    addressZip?: string;
+    dob?: string;
+    ssn?: string;
+};


@kubabutkiewicz @BartoszGrajdek check my comment above.

BartoszGrajdek · 2023-11-13T13:27:25Z

Updated the PR, please answer my comments @fabioh8010 😄

BartoszGrajdek · 2023-11-14T14:19:05Z

Great, resolved the conflicts, and fixed things you've asked for. Please take a look! 😄 @fabioh8010 @kubabutkiewicz

fabioh8010 · 2023-11-15T08:26:25Z

LGTM

blazejkustra · 2023-12-07T12:21:31Z

@BartoszGrajdek Let's add tests steps, record videos and mark as ready for review, thanks!

BartoszGrajdek · 2023-12-18T12:08:05Z

@s77rt bump 😄

s77rt · 2023-12-18T14:04:23Z

@BartoszGrajdek Can you ~~make the PersonalDetails props required~~ and check the other comment

s77rt · 2023-12-18T15:26:58Z

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

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

s77rt · 2023-12-18T15:27:12Z

@BartoszGrajdek I think the Tests / QA Tests are inverted.

Unresolved comments:

BartoszGrajdek · 2023-12-18T19:16:16Z

@s77rt fixed! Sorry, not sure how I've missed those 😅

Let me know if it's fine now 😄

s77rt · 2023-12-18T19:32:06Z

Thanks!

melvin-bot · 2023-12-18T19:32:21Z

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

NikkiWines

Looks good, some very small adjustments

NikkiWines · 2023-12-19T23:21:42Z

+            phoneNumber: parsePhoneNumber(values.phoneNumber, {regionCode: CONST.COUNTRY.US}).number.significant || '',
+            legalFirstName: values.legalFirstName || '',
+            legalLastName: values.legalLastName || '',
+            addressStreet: values.addressStreet || '',
+            addressCity: values.addressCity || '',
+            addressState: values.addressState || '',
+            addressZip: values.addressZipCode || '',
+            dob: values.dob || '',
+            ssn: values.ssn || '',


NAB: I think we prefer ?? '' in these cases

This file is in JS and turns out ?? is still forbidden in JS 😅

NikkiWines · 2023-12-19T23:28:09Z

+    const successData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.WALLET_ONFIDO,
+            value: {
+                isLoading: false,
+            },
+        },
+    ];
+
+    const failureData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: ONYXKEYS.WALLET_ONFIDO,
+            value: {
+                isLoading: false,
+            },
+        },
+    ];


This is a new convention, but since the the successData and failureData are the same, you can use a single object named finallyData here instead.

Same for any others in this file 🙇

@NikkiWines Done!

Thanks for updating this. We're looking into adding finallyData in the network layer instead. So, you can revert these changes for now (sorry, should've held off on suggesting we use finallyData) or we can wait until the corresponding PR is merged and update this one accordingly.

we can wait until the corresponding PR is merged and update this one accordingly

Let's wait then! 😄 @NikkiWines @BartoszGrajdek

Sorry for the delay, the aforementioned PR has been merged!

blazejkustra · 2024-01-10T17:35:27Z

@s77rt Could you check again?

s77rt · 2024-01-10T20:45:31Z

Retested. Working as expected

NikkiWines

Nice, thanks for your patience on this one.

NikkiWines · 2024-01-10T23:07: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(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.
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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-01-11T16:04:57Z

✋ 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-01-15T11:56:32Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.25-0 🚀

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

OSBotify · 2024-01-17T01:14:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

BartoszGrajdek added 5 commits October 23, 2023 10:31

Rename wallet.js

d14002e

[TS migration] Migrate 'Wallet.js' lib to TypeScript

43eb52d

Resolve typecheck problems in Wallet.ts

1d8e5ad

Resolve merge conflicts

c03d726

Lint fixes

a6542eb

blazejkustra suggested changes Oct 25, 2023

View reviewed changes

Comment thread src/types/onyx/WalletTerms.ts

Comment thread src/libs/actions/Wallet.ts Outdated

BartoszGrajdek added 2 commits October 26, 2023 09:26

Fixes after review for Wallet.ts

124a2db

Move type to function body

f987749

blazejkustra suggested changes Oct 27, 2023

View reviewed changes

Comment thread src/libs/actions/Wallet.ts Outdated

Comment thread src/libs/actions/Wallet.ts Outdated

BartoszGrajdek added 5 commits October 27, 2023 11:28

Refactor API requests in wallet.ts

a235b21

Remove jsdoc

5fc5072

Resolve merge conflicts

c57bbce

Resolve prettier problems

24478fe

Fix imports for Wallet.ts

6980fe2

blazejkustra approved these changes Oct 30, 2023

View reviewed changes

Rename parameters to requestParams in Wallet.ts

ac32201

kubabutkiewicz reviewed Nov 3, 2023

View reviewed changes

fabioh8010 reviewed Nov 13, 2023

View reviewed changes

Fix: move types & remove unknown

f1c7f95

BartoszGrajdek added 2 commits November 14, 2023 15:12

fix: move types

cc8fd02

Merge main

8478c77

fabioh8010 approved these changes Nov 15, 2023

View reviewed changes

BartoszGrajdek added 2 commits November 24, 2023 14:50

fix: resolve merge conflicts

791d2b0

Merge remote-tracking branch 'origin/main' into ts-migration/wallet-lib

5fcdc00

Merge remote-tracking branch 'origin/main' into ts-migration/wallet-lib

7152083

BartoszGrajdek changed the title ~~[No QA] [TS migration] Migrate 'Wallet.js' lib to TypeScript~~ [TS migration] Migrate 'Wallet.js' lib to TypeScript Dec 12, 2023

fix: lint

acda884

fix: changes after review

a581254

s77rt approved these changes Dec 18, 2023

View reviewed changes

melvin-bot Bot requested a review from NikkiWines December 18, 2023 19:32

NikkiWines requested changes Dec 19, 2023

View reviewed changes

blazejkustra and others added 6 commits December 28, 2023 15:07

Merge success and failure data into one

51e78e3

Merge branch 'main' into ts-migration/wallet-lib

35f496f

Merge remote-tracking branch 'origin/main' into ts-migration/wallet-lib

0805e14

Merge branch 'main' into ts-migration/wallet-lib

7d092eb

Merge branch 'main' into ts-migration/wallet-lib

39bb8d1

Use finallyData instead of success and failure data

3f76f08

NikkiWines approved these changes Jan 10, 2024

View reviewed changes

s77rt approved these changes Jan 11, 2024

View reviewed changes

melvin-bot Bot requested a review from NikkiWines January 11, 2024 08:25

NikkiWines merged commit 46f011f into Expensify:main Jan 11, 2024

github-actions Bot mentioned this pull request Jan 15, 2024

Deploy Checklist: New Expensify 2024-01-15 #34493

Closed

83 tasks

melvin-bot Bot mentioned this pull request Jan 17, 2024

[HOLD for payment 2024-01-24] [TS migration] Migrate 'Wallet.js' lib to TypeScript #24840

Closed

Conversation

BartoszGrajdek commented Oct 24, 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!

Uh oh!

Uh oh!

Uh oh!

blazejkustra left a comment

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!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BartoszGrajdek commented Nov 13, 2023

Uh oh!

BartoszGrajdek commented Nov 14, 2023

Uh oh!

fabioh8010 commented Nov 15, 2023

Uh oh!

blazejkustra commented Dec 7, 2023

Uh oh!

BartoszGrajdek commented Dec 18, 2023

Uh oh!

s77rt commented Dec 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

s77rt commented Dec 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt commented Dec 18, 2023

Uh oh!

BartoszGrajdek commented Dec 18, 2023

Uh oh!

s77rt commented Dec 18, 2023

Uh oh!

melvin-bot Bot commented Dec 18, 2023

Uh oh!

NikkiWines left a comment

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!

NikkiWines Jan 4, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

BartoszGrajdek commented Oct 24, 2023 •

edited

Loading

s77rt commented Dec 18, 2023 •

edited

Loading

s77rt commented Dec 18, 2023 •

edited

Loading

NikkiWines Jan 4, 2024 •

edited

Loading

NikkiWines commented Jan 10, 2024 •

edited

Loading