[TS migration] Migrate 'Onfido' component to TypeScript #31378
Conversation
| @@ -59,11 +63,10 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||
| { | |||
| type: CONST.ONFIDO.TYPE.DOCUMENT, | |||
| options: { | |||
| useLiveDocumentCapture: true, | |||
There was a problem hiding this comment.
It was removed from lib some time ago https://documentation.onfido.com/sdk/web/#no--1100
There was a problem hiding this comment.
ok, but we should make sure isn't being used in Onfido SDK, because it can be an issue with TS typings but not the code itself.
There was a problem hiding this comment.
From what I understood it was deprecated in 10.1.10, but we are at 8.3.0.
There was a problem hiding this comment.
@fabioh8010 8.3.0. is a version of @onfido/react-native-sdk which is used by mobile platforms.
The version of onfido-sdk-ui used by E/App for web is 13.1.0, so it's deprecated.
There was a problem hiding this comment.
Thanks for explanation @VickyStash !
| forceCrossDevice: true, | ||
| hideCountrySelection: true, | ||
| country: 'USA', |
There was a problem hiding this comment.
This param wasn't found by TS
There was a problem hiding this comment.
ok, but we should make sure isn't being used in Onfido SDK, because it can be an issue with TS typings but not the code itself.
There was a problem hiding this comment.
Since I don't have access to the source code it's hard to say if it's used. But based on the docs you can pass country to specific document, which is done here.
| @@ -78,17 +81,15 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||
| }, | |||
| }, | |||
| ], | |||
| smsNumberCountryCode: CONST.ONFIDO.SMS_NUMBER_COUNTRY_CODE.US, | |||
There was a problem hiding this comment.
We don't have CONST.ONFIDO.SMS_NUMBER_COUNTRY_CODE.US, we have only CONST.ONFIDO.SMS_NUMBER_COUNTRY_CODE, so all this time the undefined was used
There was a problem hiding this comment.
and what about showCountrySelection?
There was a problem hiding this comment.
showCountrySelection was removed between 8.1.1 and 8.2.0 web sdk versions
There was a problem hiding this comment.
I think this file isn't necessary anymore, the issue it mentioned is resolved.
There was a problem hiding this comment.
Let's test it to ensure no regressions are created!
|
Hey hey! We are refactoring the bank account flow it would be helpful not to do TS migrations on the BA flows until the refactor is done. I am putting thi PR on hold for now, you can see the progress of the refactor in this branch #31456 |
mountiny
changed the title
|
Let's also address this comment in this PR 🙏 |
|
@mountiny Could you please confirm, this issue is unblocked now, right? |
mountiny
changed the title
|
Yep unblocked |
# Conflicts: # src/components/Onfido/BaseOnfidoWeb.tsx # src/components/Onfido/index.native.tsx
| const {translate} = useLocalize(); | ||
|
|
||
| useEffect(() => { | ||
| OnfidoSDK.start({ | ||
| sdkToken, | ||
| theme: OnfidoTheme.AUTOMATIC, |
There was a problem hiding this comment.
theme is a required prop in OnfidoSDK.start config. I've checked the docs and OnfidoTheme.AUTOMATIC is a default value, so I've added theme prop with a default value.
| @@ -46,7 +57,6 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||
| colorBorderLinkUnderline: theme.link, | |||
| colorBackgroundLinkHover: theme.link, | |||
| colorBackgroundLinkActive: theme.link, | |||
| authAccentColor: theme.link, | |||
There was a problem hiding this comment.
This param wasn't found by TS, I haven't found it in lib/docs as well.
Onfido SDK source code is not is not publicly available to check this param there, but I can see the last version this params was mentioned in Onfido docs is 10.1.0, after that it wasn't there anymore.
melvin-bot
bot
requested review from
Santhosh-Sellavel
and removed request for
a team
|
@Santhosh-Sellavel 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] |
|
@Santhosh-Sellavel kind bump 🙂 |
|
I am unable to build the iOS App due to Xcode updates. Waiting on that... |
|
@parasharrajat hey, any updates here? 🙂 |
|
Still stuck with the error. May be you can help me bypass this issue? https://expensify.slack.com/archives/C01GTK53T8Q/p1709832511575249 |
|
@VickyStash Could you please merge the main and fix conflicts? The issue fixed on main. |
# Conflicts: # src/components/Onfido/BaseOnfidoWeb.tsx
|
@parasharrajat I've started to check functionality on |
| @@ -46,7 +57,6 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||
| colorBorderLinkUnderline: theme.link, | |||
| colorBackgroundLinkHover: theme.link, | |||
| colorBackgroundLinkActive: theme.link, | |||
| authAccentColor: theme.link, | |||
| colorBackgroundInfoPill: theme.link, | |||
| colorBackgroundSelector: theme.appBG, | |||
| colorBackgroundDocTypeButton: theme.success, | |||
There was a problem hiding this comment.
| colorBackgroundDocTypeButton: theme.success, | |
| colorBackgroundDocTypeButton: theme.success, | |
| borderWidthSurfaceModal: '0px', |
@VickyStash Could you help to add borderWidthSurfaceModal property to hide the black border (more information here)
|
@parasharrajat I've resolved conflicts, please take a look! |
|
Sure. Thanks. |
Screenshots🔲 iOS / nativeScreen.Recording.2024-03-15.at.12.22.04.AM.mov🔲 iOS / SafariRPReplay_Final1710443047.mov🔲 MacOS / DesktopScreen.Recording.2024-03-07.at.5.02.40.PM.mov🔲 MacOS / ChromeScreen.Recording.2024-03-07.at.4.57.19.PM.mov🔲 Android / ChromeScreen.Recording.2024-03-15.at.12.20.18.AM.mov🔲 Android / nativeScreen.Recording.2024-03-15.at.12.14.27.AM.mov |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
We did not find an internal engineer to review this PR, trying to assign a random engineer to #25136 as well as to this PR... Please reach out for help on Slack if no one gets assigned! |
|
@bondydaa looks like this was merged without a test passing. Please add a note explaining why this was done and remove the |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
I see all tests as passing, Melvin you're drunk. |
|
🚀 Deployed to staging by https://github.com/bondydaa in version: 1.4.54-0 🚀
|
|
🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀
|
Details
[TS migration] Migrate 'Onfido' component to TypeScript
Fixed Issues
$ #25136
PROPOSAL: N/A
Tests
Offline tests
N/A
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel so the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
android1.mp4
Android: mWeb Chrome
android_web1.mp4
iOS: Native
ios1.mp4
iOS: mWeb Safari
ios_web1.mp4
MacOS: Chrome / Safari
web1.mp4
MacOS: Desktop
desktop1.mp4