[TS migration] Migrate 'ReimbursementAccount' to TypeScript #36495

mateuuszzzzz · 2024-02-14T14:40:47Z

Details

Fixed Issues

$ #24928
PROPOSAL:

Tests

Go to settings of a workspace that you own (or have admin permissions).
Go to Reimbursements section and press Connect bank account.
Test both options for adding account (plaid and manual).
Verify that all steps are present in setup flow.
Verify that going backward and forward preserves entered data.
Verify if errors appear when incorrect data is entered and if those errors are relevant.
Check if canceling (Start over button) the flow at any point does not cause problems with future bank account setups.(e.g. if old errors don't appear in future setups and information related to previous setup is removed).

Offline tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Not sure if there are any videos to include since the pr modifies action code.

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

Desktop.mov

blazejkustra

One minor comments, otherwise LGTM!

src/libs/actions/ReimbursementAccount/store.ts

src/libs/actions/ReimbursementAccount/index.ts

src/libs/actions/ReimbursementAccount/navigation.ts

src/libs/actions/ReimbursementAccount/store.ts

src/libs/actions/ReimbursementAccount/index.ts

src/libs/actions/ReimbursementAccount/store.ts

melvin-bot · 2024-03-12T13:54:52Z

@aimane-chnaif @ One of you needs to 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]

aimane-chnaif · 2024-03-12T14:08:51Z

QA Steps is missing for this big change?

blazejkustra · 2024-03-12T14:13:04Z

@mateuuszzzzz I agree with Aimane, let's fill out tests and QA sections

aimane-chnaif

I see that lots of unused functions are removed but was it discussed?

melvin-bot · 2024-03-12T18:24:56Z

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

aimane-chnaif · 2024-03-12T18:25:19Z

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 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

aimane-chnaif · 2024-03-12T18:34:45Z

@mateuuszzzzz please merge main. 3.8k commits are too much 😮

mountiny · 2024-03-12T23:16:38Z

@mateuuszzzzz or @blazejkustra can someone merge main please

mateuuszzzzz · 2024-03-13T08:48:19Z

@mateuuszzzzz or @blazejkustra can someone merge main please

I’ll take care of it soon

mateuuszzzzz · 2024-03-13T10:20:25Z

@mountiny @aimane-chnaif done

mateuuszzzzz · 2024-03-13T10:21:24Z

I see that lots of unused functions are removed but was it discussed?

According to this. We had discussion about deleting them in this PR and decided to do it since those functions are pretty old

aimane-chnaif · 2024-03-13T10:55:20Z

This is out of scope (happens on main) but I think this is something to fix. "No error message" is confusing. User doesn't know what the issue is without seeing console log.

mountiny

@mateuuszzzzz thanks! Have you tested the full flow in the bank account and added the testing bank account succefully? Then also removed it?

Seems like there is couple of changes different from the JS so curious why they needed and hence I think we need to be thorough with testing here

src/libs/actions/ReimbursementAccount/errors.ts

mountiny · 2024-03-13T14:17:37Z

src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

+                {
+                    onyxMethod: Onyx.METHOD.SET,
+                    key: ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM_DRAFT,
+                    value: {


In the js file we just set this to empty object, why this change

Similarly here typecheck throws an error, because keys of the type used here are not optional

mountiny · 2024-03-13T14:18:14Z

src/pages/ReimbursementAccount/BankInfo/BankInfo.tsx

                    [BANK_INFO_STEP_KEYS.ACCOUNT_NUMBER]: '',
                    [BANK_INFO_STEP_KEYS.PLAID_MASK]: '',
-                    [BANK_INFO_STEP_KEYS.IS_SAVINGS]: '',
+                    [BANK_INFO_STEP_KEYS.IS_SAVINGS]: false,


why is this change needed?

Before migration we had incorrect type value here. After migration typecheck throws type mismatch so it had to be changed. Since empty string is falsy I assume using false boolean value is fine here.

mountiny · 2024-03-13T14:18:30Z

src/types/form/ReimbursementAccountForm.ts

        CITY: 'requestorAddressCity',
        STATE: 'requestorAddressState',
        ZIP_CODE: 'requestorAddressZipCode',
+        IS_ONFIDO_SETUP_COMPLETE: 'isOnfidoSetupComplete',


Why do we need this new input id here?

It turned out we use it here https://github.com/software-mansion-labs/expensify-app-fork/blob/401bb219c74fb615704895554b6876eb25601a11/src/pages/ReimbursementAccount/RequestorOnfidoStep.js#L49 and missed it before

mateuuszzzzz · 2024-03-13T15:18:18Z

@mateuuszzzzz thanks! Have you tested the full flow in the bank account and added the testing bank account succefully? Then also removed it?

Seems like there is couple of changes different from the JS so curious why they needed and hence I think we need to be thorough with testing here

@mountiny In general, I have a problem with verification via Onfido without a social security number, but this is not related to this PR. Similarly for Plaid even if the first steps are successful the verification step cannot be passed. Is there any example data that is valid and complete? All examples on #expensify-open-source seem to be outdated or incomplete.

aimane-chnaif · 2024-03-13T15:20:27Z

The logic change in this PR is resetFreePlanBankAccount flow so I think that test should be enough.

kubabutkiewicz · 2024-03-14T10:13:05Z

@mateuuszzzzz you can use those values to pass verification

mateuuszzzzz · 2024-03-14T16:31:03Z

@mountiny In my case setup was successful

mountiny

Thanks!

OSBotify · 2024-03-15T16:20:25Z

✋ 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-03-18T16:30:13Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.54-0 🚀

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

OSBotify · 2024-03-19T23:11:17Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀

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

mateuuszzzzz added 7 commits February 14, 2024 15:39

Migrate ReimbursementAccount to ts

40cd54d

Remove old js implementations

6a886fe

Add ErrorFields to PersonalBankAccount type

8b6fb5e

Adjust types

53fb383

Resolve conflicts with main

352aae4

Fix typescript errors

8406858

Fix comment typo

2fd36dd

blazejkustra approved these changes Feb 23, 2024

View reviewed changes

src/libs/actions/ReimbursementAccount/store.ts Outdated Show resolved Hide resolved

mateuuszzzzz added 2 commits February 26, 2024 11:58

Change Object.entries to Object.values

d2b3674

Add missing isOnfidoSetupComplete

c34bee5

VickyStash reviewed Mar 4, 2024

View reviewed changes

kubabutkiewicz reviewed Mar 4, 2024

View reviewed changes

src/libs/actions/ReimbursementAccount/index.ts Outdated Show resolved Hide resolved

mateuuszzzzz added 2 commits March 6, 2024 11:35

Add return type and change comment

f86fbdb

Remove unused functions

5770a2f

mateuuszzzzz requested review from VickyStash and kubabutkiewicz March 7, 2024 14:13

kubabutkiewicz reviewed Mar 8, 2024

View reviewed changes

src/libs/actions/ReimbursementAccount/store.ts Outdated Show resolved Hide resolved

src/libs/actions/ReimbursementAccount/store.ts Outdated Show resolved Hide resolved

src/libs/actions/ReimbursementAccount/store.ts Outdated Show resolved Hide resolved

Add return types and missing return

c6df4ac

mateuuszzzzz requested a review from kubabutkiewicz March 8, 2024 15:21

kubabutkiewicz approved these changes Mar 11, 2024

View reviewed changes

kubabutkiewicz mentioned this pull request Mar 11, 2024

[TS migration] Migrate 'ReimbursementAccount' page to TypeScript #37214

Merged

50 tasks

mateuuszzzzz marked this pull request as ready for review March 12, 2024 13:54

mateuuszzzzz requested a review from a team as a code owner March 12, 2024 13:54

melvin-bot bot requested review from aimane-chnaif and removed request for a team and VickyStash March 12, 2024 13:54

aimane-chnaif reviewed Mar 12, 2024

View reviewed changes

mountiny assigned mateuuszzzzz Mar 12, 2024

mateuuszzzzz added 2 commits March 13, 2024 11:06

Merge branch 'main' into ts/migrate-reimbursement-account

3b77e8d

Merge branch 'main' into ts/migrate-reimbursement-account

7613717

aimane-chnaif approved these changes Mar 13, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny March 13, 2024 11:55

mountiny reviewed Mar 13, 2024

View reviewed changes

mateuuszzzzz added 2 commits March 14, 2024 17:35

Remove redundant newline

442f693

Merge branch 'main' into ts/migrate-reimbursement-account

5d792b7

mountiny approved these changes Mar 15, 2024

View reviewed changes

mountiny merged commit 62b1b35 into Expensify:main Mar 15, 2024

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

Deploy Checklist: New Expensify 2024-03-18 #38489

Closed

65 tasks

This was referenced Mar 19, 2024

IOS - Workspace - There is no error message for an incorrect account number #38575

Closed

Workspace - Deleted bank account appears if you add a new after disconnecting #38598

Closed

tienifr mentioned this pull request Mar 19, 2024

[HOLD for payment 2024-04-15] [$250] Bank account - Company's website field is missing https:// #38585

Closed

6 tasks

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

[HOLD for payment 2024-05-21] [TS migration] Migrate 'ReimbursementAccount' lib to TypeScript #24928

Closed

[TS migration] Migrate 'ReimbursementAccount' to TypeScript #36495

[TS migration] Migrate 'ReimbursementAccount' to TypeScript #36495

Uh oh!

Conversation

mateuuszzzzz commented Feb 14, 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!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

aimane-chnaif commented Mar 12, 2024

Uh oh!

blazejkustra commented Mar 12, 2024

Uh oh!

aimane-chnaif left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

aimane-chnaif commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

aimane-chnaif commented Mar 12, 2024

Uh oh!

mountiny commented Mar 12, 2024

Uh oh!

mateuuszzzzz commented Mar 13, 2024

Uh oh!

mateuuszzzzz commented Mar 13, 2024

Uh oh!

mateuuszzzzz commented Mar 13, 2024

Uh oh!

aimane-chnaif commented Mar 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

mateuuszzzzz Mar 13, 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!

mountiny Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

mateuuszzzzz Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

mateuuszzzzz Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

mateuuszzzzz commented Mar 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

mateuuszzzzz commented Feb 14, 2024 •

edited

Loading

aimane-chnaif commented Mar 12, 2024 •

edited

Loading

aimane-chnaif commented Mar 13, 2024 •

edited

Loading

mateuuszzzzz Mar 13, 2024 •

edited

Loading

mateuuszzzzz commented Mar 13, 2024 •

edited

Loading