feat: migrate onfido web component from class to functioncal #28815

MrMuzyk · 2023-10-04T13:49:51Z

Details

Migrating Onfido index.webstie.js component from class to functional

Fixed Issues

$ #16179
PROPOSAL:

Tests

Use staging server
Follow QA steps

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to any workspace
Continue with previous setup or Connect bank manually
Complete until steps 3 of 5
Tap Save & Continue
You should be navigated to new page and Onfido process should start properly

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

web.mov

Mobile Web - Chrome

n/a

Mobile Web - Safari

ios.safari.mov

Desktop

n/a

iOS

n/a

Android

n/a

Swor71

lgtm

melvin-bot · 2023-10-05T09:02:12Z

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

cubuspl42 · 2023-10-05T09:20:48Z

There's a guideline not to leave the QA Steps empty. When in doubt, you can fill in only the QA Steps, and in the "Tests" section, write "Same as QA Steps".

Actually, in this case, "Use staging server" is something that makes sense only for Dev, so I guess you can write

## Tests

- Use the staging server
- Follow the QA Steps

mountiny · 2023-10-05T10:42:20Z

src/components/Onfido/index.website.js

-        super(props);
-        this.baseOnfido = null;
-    }
+const Onfido = (props) => {


prefer props deconstructing

cubuspl42 · 2023-10-05T11:10:03Z

@MrMuzyk

Would you upload screenshots/videos for other platforms? I would be especially interested in a video for Android / Chrome.

…teToFunctional

MrMuzyk · 2023-10-05T12:27:12Z

Ive pushed fixes and updated description. Ive added recording for mobile safari.

@cubuspl42
For android chrome Im getting info that browser is outdated. Im getting this on both this branch and main on 2 different emulators. I don't have any other device to verify this on. Probably this is what you were curious about :)

Screen.Recording.2023-10-05.at.14.13.26.mov

cubuspl42 · 2023-10-05T14:30:57Z

@MrMuzyk Yes, I had similar results. It's interesting because it's inconsistent between iOS/Safari and Android/Chrome.

Still, I could guess that this is a weird way to say "we detected this is a dev environment and we don't like it", but I'm not sure why would it be platform-specific.

cubuspl42 · 2023-10-05T14:49:45Z

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

migrateOnfidoWebsiteToFunctional-web.mp4

Mobile Web - Chrome

migrateOnfidoWebsiteToFunctional-android-web-compressed.mp4

Mobile Web - Safari

migrateOnfidoWebsiteToFunctional-ios-web.mp4

Desktop

migrateOnfidoWebsiteToFunctional-desktop.mp4

iOS

migrateOnfidoWebsiteToFunctional-ios.mp4

Android

migrateOnfidoWebsiteToFunctional-android-compressed.mp4

cubuspl42

@mountiny

I approve with the following notes:

For some platforms, screenshots/videos aren't provided by the contributor
- I leave the decision whether this is a blocker to you; I think we can proceed. I covered all platforms
There is a problem with testing on Android Chrome, when an error is shown about the outdated browser, even when the browser is up-to-date. This is not a regression compared to main and might be a problem with testing in the development environment.
- I think we can assume this is not related to this refactoring (as the chance is really small) and focus on testing this on staging

@MrMuzyk

Please try to cover all platforms with screenshots, or preferably, videos next time

mountiny

Alright, thanks and I agree @MrMuzyk please add proof of testing all platforms next time!

OSBotify · 2023-10-05T17:21:10Z

✋ 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-06T08:23:54Z

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

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

OSBotify · 2023-10-09T22:32:27Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T22:41:21Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T23:17:15Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

feat: migrate onfido web component from class to functioncal

563ee0d

Swor71 approved these changes Oct 4, 2023

View reviewed changes

MrMuzyk marked this pull request as ready for review October 5, 2023 09:02

MrMuzyk requested a review from a team as a code owner October 5, 2023 09:02

melvin-bot bot requested review from cubuspl42 and removed request for a team October 5, 2023 09:02

mountiny assigned MrMuzyk Oct 5, 2023

mountiny reviewed Oct 5, 2023

View reviewed changes

MrMuzyk added 2 commits October 5, 2023 13:51

Merge branch 'main' of github.com:MrMuzyk/App into migrateOnfidoWebsi…

460583a

…teToFunctional

fix: cr fixes

da85209

cubuspl42 approved these changes Oct 5, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny October 5, 2023 14:57

mountiny approved these changes Oct 5, 2023

View reviewed changes

mountiny merged commit 4078503 into Expensify:main Oct 5, 2023
13 checks passed

OSBotify mentioned this pull request Oct 6, 2023

Deploy Checklist: New Expensify 2023-10-06 #28983

Closed

melvin-bot bot mentioned this pull request Oct 9, 2023

[HOLD for payment 2023-10-16] [$250] Migrate index.website.js to function component #16179

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate onfido web component from class to functioncal #28815

feat: migrate onfido web component from class to functioncal #28815

MrMuzyk commented Oct 4, 2023 •

edited

Loading

Swor71 left a comment

melvin-bot bot commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

mountiny Oct 5, 2023

cubuspl42 commented Oct 5, 2023

MrMuzyk commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

cubuspl42 left a comment

mountiny left a comment

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

feat: migrate onfido web component from class to functioncal #28815

feat: migrate onfido web component from class to functioncal #28815

Conversation

MrMuzyk commented Oct 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Swor71 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

mountiny Oct 5, 2023

Choose a reason for hiding this comment

cubuspl42 commented Oct 5, 2023

MrMuzyk commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

cubuspl42 commented Oct 5, 2023

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

MrMuzyk commented Oct 4, 2023 •

edited

Loading