Refactor: Migrate BankAccountManualStep.js to function component #22245

Vishrut19 · 2023-07-05T06:38:23Z

Details

Fixed Issues

$ #16241
PROPOSAL: 16241(COMMENT)

Tests

Go to settings.
Click the workspaces
Create a workspace or click the already created workspace
Click the Reimbursements
Click the Connect Bank Account
Click the Connect Manually
Please make sure you must set the currency as USD in workspace settings.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to settings.
Click the workspaces
Create a workspace or click the already created workspace
Click the Reimbursements
Click the Connect Bank Account
Click the Connect Manually
Please make sure you must set the currency as USD in workspace settings.

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

Screen.Recording.2023-07-05.at.12.22.47.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

github-actions · 2023-07-05T06:38:41Z

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

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

Vishrut Agarwalla seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request}

Vishrut19 · 2023-07-05T06:39:28Z

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

melvin-bot · 2023-07-05T07:53:52Z

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

src/pages/ReimbursementAccount/BankAccountManualStep.js

parasharrajat · 2023-07-05T12:56:13Z

Missing details.

Vishrut19 · 2023-07-05T13:38:28Z

Missing details.

Done

src/pages/ReimbursementAccount/BankAccountManualStep.js

parasharrajat · 2023-07-05T15:02:53Z

Please fix it

src/pages/workspace/WorkspaceInvitePage.js

parasharrajat · 2023-07-06T08:48:52Z

Fix merge conflicts.

Vishrut19 · 2023-07-06T08:50:00Z

Fix merge conflicts.

Created a seperate PR for that other issue which already resolves the merge conflict

parasharrajat · 2023-07-06T08:52:12Z

It was fine to keep it here if you already added the code. Instead of removing it, I asked to add that issue to the template as well. But it's OK where we have landed. Please fix the conflicts here.

parasharrajat · 2023-07-06T09:11:17Z

You can do the following.

There are many extra commits here.

So remove all the commits that are done today.

3. Then check the commits 
git reset --hard edea17abf52fb6cba234fa7e0d8c1529d62bab15 #commit number to reset the head to

Then force push.

git push -f

Vishrut19 · 2023-07-06T09:19:41Z

You can do the following.

There are many extra commits here.

So remove all the commits that are done today.
3. Then check the commits 
git reset --hard edea17abf52fb6cba234fa7e0d8c1529d62bab15 #commit number to reset the head to
Then force push.
git push -f

Thanks a lot for helping! I was a bit confused

Vishrut19 · 2023-07-06T09:24:18Z

@parasharrajat please review it and merge if everything is good

src/pages/ReimbursementAccount/BankAccountManualStep.js

Vishrut19 · 2023-07-08T12:17:01Z

Did you test the page after refactoring? I can't type anything in the fields.

Yes, it was working perfectly fine. Maybe this is happening because of some other component

parasharrajat · 2023-07-08T12:29:51Z

Please use proper commit messages. We should be serious about these. They are info that we look back on in the future.

Vishrut19 · 2023-07-08T12:36:05Z

Please use proper commit messages. We should be serious about these. They are info that we look back on in the future.

Oh okay sorry. Do you want me to change it ? And also sorry since it is my first contribution to Expensify so that's why. For future I will keep it in mind

parasharrajat · 2023-07-08T12:39:22Z

I think yes we should because it is possible. Let's just change the last commit.

git commit --amend -m "Use defaultValue for textInputs in the Form"

parasharrajat · 2023-07-08T12:45:06Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-07-08.at.6.19.49.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-07-08.at.6.11.41.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-07-08.at.6.05.23.PM.mov

🔲 MacOS / Chrome

🔲 Android / Chrome

Screen.Recording.2023-07-08.at.6.13.08.PM.mov

🔲 Android / native

Screen.Recording.2023-07-08.at.6.06.15.PM.mov

parasharrajat · 2023-07-08T12:49:06Z

Now there are extra commits. You had to force push after running the above command. Now run the following commands one by one.

git reset --hard HEAD^2
git commit --amend -m "Use defaultValue for textInputs in the Form"
git push -f

Please practice git basics.

Vishrut19 · 2023-07-08T12:53:26Z

Now there are extra commits. You had to force push after running the above command. Now run the following commands one by one.
git reset --hard HEAD^2
git commit --amend -m "Use defaultValue for textInputs in the Form"
git push -f
Please practice git basics.

Done and thanks

Vishrut19 · 2023-07-08T12:54:17Z

I think yes we should because it is possible. Let's just change the last commit.
git commit --amend -m "Use defaultValue for textInputs in the Form"

done

src/pages/ReimbursementAccount/BankAccountManualStep.js

parasharrajat · 2023-07-09T07:55:59Z

Did you find it?

parasharrajat

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 / Chrome
- iOS / native
- iOS / 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 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.

🎀 👀 🎀 C+ reviewed

Vishrut19 · 2023-07-09T07:58:59Z

Did you find it?

what? the value things? Yes I found it and I changed it to defaultValue from value

thienlnam · 2023-07-10T17:46:19Z

src/pages/ReimbursementAccount/BankAccountManualStep.js

@@ -19,115 +21,116 @@ import ScreenWrapper from '../../components/ScreenWrapper';
 import StepPropTypes from './StepPropTypes';

 const propTypes = {
-    ...StepPropTypes,
+    ..._.omit(StepPropTypes, _.keys(withLocalizePropTypes)),


Why are we removing the withLocalizePropTypes in prop types?

We moved to useLocalize from HOC so no such props will be passed.

Then could we not include it in StepPropTypes? Or is that too big of a refactor

We can't remove it yet from StepPropTyped as that is still used in many other components so when last of that component is refactored to function, we can safely refactor all.

Cool cool, thanks for the context

thienlnam · 2023-07-10T18:17:13Z

Waiting for workflows before merging

Vishrut19 · 2023-07-10T19:48:13Z

Waiting for workflows before merging

so when will it get merged?

OSBotify · 2023-07-10T20:21:31Z

✋ 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-07-11T00:19:16Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.39-0 🚀

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

OSBotify · 2023-07-13T01:43:18Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

Li357 · 2023-07-26T18:43:08Z

src/pages/ReimbursementAccount/BankAccountManualStep.js

+    const submit = useCallback(
+        (values) => {
+            BankAccounts.connectBankAccountManually(
+                lodashGet(reimbursementAccount, ['achData.bankAccountID']) || 0,


Looks like this line caused this regression. Why did you convert lodashGet to an array path? Regardless, this should be lodashGet(reimbursementAccount, ['achData', 'bankAccountID'])

Oops, I completely missed this during refactor. There is one more.

Refactored React Functional Component

ed23446

Vishrut19 marked this pull request as ready for review July 5, 2023 07:53

Vishrut19 requested a review from a team as a code owner July 5, 2023 07:53

melvin-bot bot requested review from parasharrajat and removed request for a team July 5, 2023 07:53

Refactored React Functional Component

87f3acb

parasharrajat suggested changes Jul 5, 2023

View reviewed changes

src/pages/ReimbursementAccount/BankAccountManualStep.js Outdated Show resolved Hide resolved

src/pages/ReimbursementAccount/BankAccountManualStep.js Outdated Show resolved Hide resolved

Added Dependency Arrays

e2e1676

Vishrut19 requested a review from parasharrajat July 5, 2023 14:59

parasharrajat reviewed Jul 5, 2023

View reviewed changes

src/pages/ReimbursementAccount/BankAccountManualStep.js Outdated Show resolved Hide resolved

Vishrut19 requested a review from parasharrajat July 5, 2023 15:05

Merge branch 'Expensify:main' into main

edea17a

parasharrajat reviewed Jul 6, 2023

View reviewed changes

src/pages/workspace/WorkspaceInvitePage.js Outdated Show resolved Hide resolved

Vishrut19 requested a review from parasharrajat July 6, 2023 08:40

Merge branch 'Expensify:main' into main

d1f6c4d

parasharrajat reviewed Jul 7, 2023

View reviewed changes

src/pages/ReimbursementAccount/BankAccountManualStep.js Outdated Show resolved Hide resolved

parasharrajat reviewed Jul 7, 2023

View reviewed changes

src/pages/ReimbursementAccount/BankAccountManualStep.js Show resolved Hide resolved

useLocalize Hook Added and Prop Destructuring

a214f28

Use defaultValue for textInputs in the Form

da2f288

parasharrajat reviewed Jul 8, 2023

View reviewed changes

src/pages/ReimbursementAccount/BankAccountManualStep.js Outdated Show resolved Hide resolved

Vishrut19 requested a review from parasharrajat July 8, 2023 13:18

In the TextInput Value changed to defaultValue

a23ca39

parasharrajat approved these changes Jul 9, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam July 9, 2023 07:56

Vishrut19 requested a review from parasharrajat July 9, 2023 07:59

thienlnam reviewed Jul 10, 2023

View reviewed changes

thienlnam approved these changes Jul 10, 2023

View reviewed changes

thienlnam merged commit 3f76eaa into Expensify:main Jul 10, 2023
17 checks passed

OSBotify mentioned this pull request Jul 10, 2023

Deploy Checklist: New Expensify 2023-07-10 #22598

Closed

76 tasks

bernhardoj mentioned this pull request Jul 23, 2023

[$1000] Web - App allows to move to next step even when we keep account no and routing number same #23413

Closed

6 tasks

Li357 reviewed Jul 26, 2023

View reviewed changes

Li357 mentioned this pull request Jul 26, 2023

Fix bankAccountID not being passed on manual BA connect #23677

Merged

58 tasks

situchan mentioned this pull request Aug 7, 2023

[HOLD for payment 2023-08-08] Bank account - Personal information is cleared after returning to it from 'Connect BA' page #23408

Closed

6 tasks

Refactor: Migrate BankAccountManualStep.js to function component #22245

Refactor: Migrate BankAccountManualStep.js to function component #22245

Conversation

Vishrut19 commented Jul 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jul 5, 2023 • edited Loading

Vishrut19 commented Jul 5, 2023

melvin-bot bot commented Jul 5, 2023

parasharrajat commented Jul 5, 2023

Vishrut19 commented Jul 5, 2023

parasharrajat commented Jul 5, 2023

parasharrajat commented Jul 6, 2023

Vishrut19 commented Jul 6, 2023

parasharrajat commented Jul 6, 2023

parasharrajat commented Jul 6, 2023 • edited Loading

Vishrut19 commented Jul 6, 2023

Vishrut19 commented Jul 6, 2023

Vishrut19 commented Jul 8, 2023

parasharrajat commented Jul 8, 2023

Vishrut19 commented Jul 8, 2023

parasharrajat commented Jul 8, 2023

parasharrajat commented Jul 8, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat commented Jul 8, 2023 • edited Loading

Vishrut19 commented Jul 8, 2023

Vishrut19 commented Jul 8, 2023

parasharrajat commented Jul 9, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Vishrut19 commented Jul 9, 2023

thienlnam Jul 10, 2023

Choose a reason for hiding this comment

parasharrajat Jul 10, 2023

Choose a reason for hiding this comment

thienlnam Jul 10, 2023

Choose a reason for hiding this comment

parasharrajat Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

thienlnam Jul 10, 2023

Choose a reason for hiding this comment

thienlnam commented Jul 10, 2023

Vishrut19 commented Jul 10, 2023

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

Li357 Jul 26, 2023

Choose a reason for hiding this comment

parasharrajat Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Vishrut19 commented Jul 5, 2023 •

edited

Loading

github-actions bot commented Jul 5, 2023 •

edited

Loading

parasharrajat commented Jul 6, 2023 •

edited

Loading

parasharrajat commented Jul 8, 2023 •

edited

Loading

parasharrajat commented Jul 8, 2023 •

edited

Loading

parasharrajat Jul 10, 2023 •

edited

Loading

parasharrajat Jul 26, 2023 •

edited

Loading