feat: migrate KYCWall class component to functional by Swor71 · Pull Request #28798 · Expensify/App

Swor71 · 2023-10-04T10:51:55Z

Details

Migration of KYCWall class component to functional one

Fixed Issues

$ #16170
PROPOSAL:

Tests

log into the app
press the FAB and request money from e.g. workspace that you are a part of (to make it easier and not have to jump between accounts)
select the said workspace and press on pay with Expensify
confirm that the pop up shows in which you can select an option and be navigated to it
Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

src/components/KYCWall/BaseKYCWall.js

Swor71 · 2023-10-04T11:39:34Z

src/components/KYCWall/BaseKYCWall.js

-    continue(event, iouPaymentType) {
-        if (this.state.shouldShowAddPaymentMenu) {
-            this.setState({shouldShowAddPaymentMenu: false});
+    const continueAction = (event, iouPaymentType) => {


btw had to change the name as continue is a forbidden keyword

src/components/KYCWall/BaseKYCWall.js

MrMuzyk · 2023-10-04T12:31:01Z

LGTM

The only thing im wondering about is the PaymentMethods.kycWallRef

It seems really hacky together with the continueAction method and its the only place where it is being set. However it would probably require refactoring other components too so I think there is no point in changing it here

…ponent declaration

melvin-bot · 2023-10-09T14:33:34Z

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

abdulrahuman5196 · 2023-10-10T12:56:14Z

@Swor71 What are the tests for this? There is none in author's checklist?

Swor71 · 2023-10-10T13:57:29Z

@abdulrahuman5196 hey, apologies for missing that part, added the steps now

abdulrahuman5196 · 2023-10-11T16:00:28Z

src/components/KYCWall/BaseKYCWall.js

+    );
 }

 KYCWall.propTypes = propTypes;


Functional components are expected to have a displayName value

@abdulrahuman5196 I am aware of this, however this component is exported from the index.js file which has the displayName https://github.com/Expensify/App/blob/main/src/components/KYCWall/index.js#L17

~~Would you like me to add that line to this component as well?~~

EDIT: I've actually added the displayName for the base component as well

abdulrahuman5196 · 2023-10-12T14:34:56Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-10-12.at.7.34.26.PM.mp4

Mobile Web - Chrome

Screen.Recording.2023-10-12.at.7.43.10.PM.mp4

Mobile Web - Safari

Screen.Recording.2023-10-12.at.7.42.08.PM.mp4

Desktop

Screen.Recording.2023-10-12.at.8.00.18.PM.mp4

iOS

Screen.Recording.2023-10-12.at.7.48.44.PM.mp4

Android

Screen.Recording.2023-10-12.at.7.49.09.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @bondydaa

🎀 👀 🎀
C+ Reviewed

melvin-bot · 2023-10-12T14:36:00Z

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

abdulrahuman5196 · 2023-10-12T14:37:19Z

@bondydaa Kindly run the workflows before review/merging.

Swor71 · 2023-10-17T08:29:16Z

@abdulrahuman5196 @bondydaa
hey, just wanted to ask, if there is any blocker with this PR getting merged?

bondydaa · 2023-10-17T22:14:48Z

looks like conflicts

Swor71 · 2023-10-18T08:29:00Z

@bondydaa
well just my luck ;) for the 5 days since C+ approved the changes there were no conflicts, either way the conflicts are fixed now, please have a look when you get a chance, thanks!

Swor71 · 2023-10-20T14:44:57Z

@abdulrahuman5196 @bondydaa
hey again, could we get this over the line, please? I've been fixing conflicts on this for the past three days as a new one comes up each day, the pr has been approved by C+ over a week ago. Thanks!

OSBotify · 2023-10-20T21:28:43Z

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

OSBotify · 2023-10-20T22:10:36Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.88-1 🚀

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

bondydaa · 2023-10-20T22:30:48Z

this started causing a crash so we reverted it here #30110

bondydaa · 2023-10-20T22:40:49Z

The bigger reason for the revert is we have a conference starting sunday which we've been testing specifically the flows of #29573 to ensure they work for that event.

I should have held this PR initially but wasn't thinking when I merged it.

OSBotify · 2023-10-20T22:42:04Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.88-1 🚀

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

OSBotify · 2023-10-23T04:48:57Z

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

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

feat: migrate KYCWall class component to functional

2df7e2c

MrMuzyk reviewed Oct 4, 2023

View reviewed changes

src/components/KYCWall/BaseKYCWall.js Outdated Show resolved Hide resolved

Swor71 commented Oct 4, 2023

View reviewed changes

change: moved anchor position offsets to CONST file

1390178

MrMuzyk reviewed Oct 4, 2023

View reviewed changes

src/components/KYCWall/BaseKYCWall.js Outdated Show resolved Hide resolved

Swor71 added 3 commits October 4, 2023 15:07

change: moved anchor position offsets back to KYCWall file before com…

b981474

…ponent declaration

fix: assignment to transferBalanceButtonRef

851b3ac

Merge branch 'main' into migrate/16170-KYCWall-to-functional

29c05bd

Swor71 marked this pull request as ready for review October 9, 2023 14:33

Swor71 requested a review from a team as a code owner October 9, 2023 14:33

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team October 9, 2023 14:33

abdulrahuman5196 suggested changes Oct 11, 2023

View reviewed changes

Swor71 added 2 commits October 12, 2023 12:09

Merge branch 'main' into migrate/16170-KYCWall-to-functional

b6b6be1

add: displayName for BaseKYCWall

52f43e4

abdulrahuman5196 approved these changes Oct 12, 2023

View reviewed changes

melvin-bot bot requested a review from bondydaa October 12, 2023 14:36

Merge branch 'main' into migrate/16170-KYCWall-to-functional

d1db95f

Merge branch 'main' into migrate/16170-KYCWall-to-functional

280e4e5

Merge branch 'main' into migrate/16170-KYCWall-to-functional

89b5618

Merge branch 'main' into migrate/16170-KYCWall-to-functional

f27220a

bondydaa approved these changes Oct 20, 2023

View reviewed changes

bondydaa merged commit fba87cd into Expensify:main Oct 20, 2023

OSBotify mentioned this pull request Oct 20, 2023

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

Closed

mallenexpensify mentioned this pull request Oct 20, 2023

[HOLD for payment 2023-10-31] Staging is crashing when opening a chat #30109

Closed

6 tasks

bondydaa mentioned this pull request Oct 20, 2023

Revert "feat: migrate KYCWall class component to functional" #30110

Merged

57 tasks

bondydaa mentioned this pull request Oct 20, 2023

[Awaiting Payment][$250] Migrate BaseKYCWall.js to function component #16170

Closed

1 task

teneeto mentioned this pull request Nov 21, 2023

Chore: Migrate BaseKYCWall.js to function component #31538

Merged

58 tasks

Conversation

Swor71 commented Oct 4, 2023 • edited by SBUstinov 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!

Swor71 Oct 4, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MrMuzyk commented Oct 4, 2023

Uh oh!

melvin-bot bot commented Oct 9, 2023

Uh oh!

abdulrahuman5196 commented Oct 10, 2023

Uh oh!

Swor71 commented Oct 10, 2023

Uh oh!

abdulrahuman5196 Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

Swor71 Oct 12, 2023 • 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!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

abdulrahuman5196 left a comment • 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!

melvin-bot bot commented Oct 12, 2023

Uh oh!

abdulrahuman5196 commented Oct 12, 2023

Uh oh!

Swor71 commented Oct 17, 2023

Uh oh!

bondydaa commented Oct 17, 2023

Uh oh!

Swor71 commented Oct 18, 2023

Uh oh!

Swor71 commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

bondydaa commented Oct 20, 2023

Uh oh!

bondydaa commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Swor71 commented Oct 4, 2023 •

edited by SBUstinov

Loading

Swor71 Oct 12, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 12, 2023 •

edited

Loading

abdulrahuman5196 left a comment •

edited

Loading