[Onfido] Fix use of locale in Onfido #17943

Prince-Mendiratta · 2023-04-24T23:23:49Z

Details

With this PR, we are adding the changes to ensure that the Onfido flow initialises in Spanish if the user locale is Spanish.

Fixed Issues

$ #17789
$ #17244 (comment)
PROPOSAL: #17789 (comment)

Tests

Login to ND.
Go to Settings > Workspaces > Any workspace > connect bank account.
Fill any information till you reach step 3.
Once you fill step 3 and click next, you will be redirected to Onfido flow.
Choose either 'Passport' or "Driver's license". Hover over the back button.
Ensure that the text displayed is Back for english.
Go to Settings > Preferences > Language and choose Spanish.
Repeat steps 2-5 and ensure that the Onfido flow is in Spanish as well as the text displayed is Volver when hovering over the back button.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as above.

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

I have added screenshots only for the platforms affected. Let me know if you think otherwise and other are required as well.

Web

Desktop

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

saiKumarGanji · 2023-04-25T05:03:20Z

src/components/Onfido/BaseOnfidoWeb.js

@@ -105,7 +105,7 @@ class Onfido extends React.Component {
                Log.hmmm('Onfido user closed the modal');
            },
            language: {
-                locale: this.props.preferredLocale,
+                locale: this.props.preferredLocale === CONST.LOCALES.ES ? CONST.ONFIDO.ES_ES_LOCALE : CONST.LOCALES.EN,


Suggestion:
Expensify currently supports english and spanish.
But can we make it as below, so that other languages work if included in future

locale: this.props.preferredLocale === CONST.LOCALES.ES ? CONST.ONFIDO.ES_ES_LOCALE : this.props.preferredLocale

Thanks @saiKumarGanji, that's a good idea. But I'm still unsure about the supported language for customization. In the doc example for en, it's using en_US. Also based on the repo https://github.com/onfido/onfido-sdk-ui/tree/master/locales the locals also have specific tags for other languages.

@mollfpr Let's keep it en for now?

@Prince-Mendiratta Is there any difference if we use en without a tag?

@mollfpr Nope, works well with just en as well.

mollfpr

@Prince-Mendiratta Let's move it to a better place, and have a fallback to the preferredLocale.

src/CONST.js

src/components/Onfido/BaseOnfidoWeb.js

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

Prince-Mendiratta · 2023-04-28T14:59:08Z

@mollfpr updated!

mollfpr · 2023-04-28T15:20:53Z

src/CONST.js

@@ -910,6 +910,7 @@ const CONST = {
        ES: 'es',

        DEFAULT: 'en',
+        ES_ES_ONFIDO: 'es_ES',


I like its place below the ES_ES; it's easy to notice the difference. Let's leave DEFAULT alone 😄

@mollfpr yeah that'd looks good, updated!

mollfpr · 2023-04-28T15:21:48Z

src/components/Onfido/BaseOnfidoWeb.js

@@ -105,7 +105,7 @@ class Onfido extends React.Component {
                Log.hmmm('Onfido user closed the modal');
            },
            language: {
-                locale: this.props.preferredLocale,
+                locale: this.props.preferredLocale === CONST.LOCALES.ES ? CONST.LOCALES.ES_ES_ONFIDO : this.props.preferredLocale,


Also, let's add a description of why we can't use CONST.LOCALES.ES here.

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

mollfpr · 2023-04-28T15:36: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 / 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.

Screenshots/Videos

Web

EN	ES

Mobile Web - Chrome

Mobile Web - Safari

Desktop

EN	ES

iOS

Android

mollfpr

LGTM and tests well 👍

All yours @neil-marcellini

Prince-Mendiratta · 2023-04-28T15:38:35Z

Thanks all! Sorry for the regression and delay on this PR.

neil-marcellini

Thanks for the fix! I'm not sure how we missed it before, I could have sworn I tested it and it displayed properly in Spanish before.

OSBotify · 2023-04-28T19:36:29Z

✋ 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-05-03T00:07:59Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.9-12 🚀

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

OSBotify · 2023-05-09T04:07:58Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

fix: use correct locale key

99c6891

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

Prince-Mendiratta requested a review from a team as a code owner April 24, 2023 23:23

saiKumarGanji reviewed Apr 25, 2023

View reviewed changes

mollfpr suggested changes Apr 28, 2023

View reviewed changes

src/CONST.js Outdated Show resolved Hide resolved

src/components/Onfido/BaseOnfidoWeb.js Outdated Show resolved Hide resolved

fix: use props locale as fallback

332bee9

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

mollfpr reviewed Apr 28, 2023

View reviewed changes

Prince-Mendiratta added 2 commits April 28, 2023 20:52

fix: reorder keys

004d005

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

fix: add desc

3e0ecb8

Signed-off-by: Prince Mendiratta <prince.mendi@gmail.com>

mollfpr approved these changes Apr 28, 2023

View reviewed changes

neil-marcellini self-requested a review April 28, 2023 16:18

neil-marcellini approved these changes Apr 28, 2023

View reviewed changes

neil-marcellini merged commit 6799d29 into Expensify:main Apr 28, 2023

OSBotify mentioned this pull request May 2, 2023

Deploy Checklist: New Expensify 2023-05-02 #18315

Closed

marcaaron mentioned this pull request May 3, 2023

Deploy Checklist: New Expensify 2023-05-02 #18322

Closed

59 tasks

kbecciv mentioned this pull request May 3, 2023

Android - Onfido - Back button is English instead of Spanish #18344

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Onfido] Fix use of locale in Onfido #17943

[Onfido] Fix use of locale in Onfido #17943

Prince-Mendiratta commented Apr 24, 2023

saiKumarGanji Apr 25, 2023 •

edited

Loading

mollfpr Apr 25, 2023

Prince-Mendiratta Apr 27, 2023

mollfpr Apr 28, 2023

Prince-Mendiratta Apr 28, 2023

mollfpr left a comment

Prince-Mendiratta commented Apr 28, 2023

mollfpr Apr 28, 2023

Prince-Mendiratta Apr 28, 2023

mollfpr Apr 28, 2023

mollfpr commented Apr 28, 2023

mollfpr left a comment

Prince-Mendiratta commented Apr 28, 2023

neil-marcellini left a comment

OSBotify commented Apr 28, 2023

OSBotify commented May 3, 2023

OSBotify commented May 9, 2023

[Onfido] Fix use of locale in Onfido #17943

[Onfido] Fix use of locale in Onfido #17943

Conversation

Prince-Mendiratta commented Apr 24, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

saiKumarGanji Apr 25, 2023 • edited Loading

Choose a reason for hiding this comment

mollfpr Apr 25, 2023

Choose a reason for hiding this comment

Prince-Mendiratta Apr 27, 2023

Choose a reason for hiding this comment

mollfpr Apr 28, 2023

Choose a reason for hiding this comment

Prince-Mendiratta Apr 28, 2023

Choose a reason for hiding this comment

mollfpr left a comment

Choose a reason for hiding this comment

Prince-Mendiratta commented Apr 28, 2023

mollfpr Apr 28, 2023

Choose a reason for hiding this comment

Prince-Mendiratta Apr 28, 2023

Choose a reason for hiding this comment

mollfpr Apr 28, 2023

Choose a reason for hiding this comment

mollfpr commented Apr 28, 2023

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

Prince-Mendiratta commented Apr 28, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 28, 2023

OSBotify commented May 3, 2023

OSBotify commented May 9, 2023

saiKumarGanji Apr 25, 2023 •

edited

Loading