Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Onfido back button issue #16333

Merged
merged 2 commits into from
Mar 23, 2023
Merged

Conversation

allroundexperts
Copy link
Contributor

@allroundexperts allroundexperts commented Mar 21, 2023

Details

This PR edits the Onfido web sdk, such that it uses useMemoryHistory. Without it, the back button on Onfido page does not work correctly on web.

Fixed Issues

$ #16020
PROPOSAL: #16020 (comment)

Tests

On Web:

  1. Go to connect bank account, add details and continue to choose documents page
  2. Out of two accepted documents, select any
  3. ( I selected passports) Now click small back button below personal Information header.
  4. (back button sends to previous page) Now again select any accepted document button again.
  5. Verify that the back button works as expected.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

On Web:

  1. Go to connect bank account, add details and continue to choose documents page
  2. Out of two accepted documents, select any
  3. ( I selected passports) Now click small back button below personal Information header.
  4. (back button sends to previous page) Now again select any accepted document button again.
  5. Verify that the back button works as expected.
  • 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
    • 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 correct English and 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 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.
  • 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-03-21.at.1.17.27.PM.mov
Mobile Web - Chrome

Unable to test on Android Chrome because of the following issue:
https://user-images.githubusercontent.com/30054992/226554510-0556cd51-8bd7-429b-9f16-d66042e50070.mov

Mobile Web - Safari
Screen.Recording.2023-03-21.at.1.23.05.PM.mov
Desktop
Screen.Recording.2023-03-21.at.1.19.50.PM.mov
iOS
Screen.Recording.2023-03-21.at.1.27.17.PM.mov
Android
Screen.Recording.2023-03-21.at.1.29.47.PM.mov

@allroundexperts allroundexperts marked this pull request as ready for review March 21, 2023 08:40
@allroundexperts allroundexperts requested a review from a team as a code owner March 21, 2023 08:40
@melvin-bot melvin-bot bot requested review from hayata-suenaga and Santhosh-Sellavel and removed request for a team March 21, 2023 08:40
@MelvinBot
Copy link

@hayata-suenaga @Santhosh-Sellavel One of you needs to 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
Copy link
Collaborator

Santhosh-Sellavel commented Mar 21, 2023

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 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 correct English and 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 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

Desktop & Web
Screen.Recording.2023-03-21.at.8.29.46.PM.mov
Mobile Web - Chrome
Mobile Web - Safari
Simulator.Screen.Recording.-.iPhone.14.-.2023-03-21.at.20.10.37.mp4
iOS & Android
Screen.Recording.2023-03-21.at.2.54.22.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

@hayata-suenaga

Something's off on mWeb Android alone, do we have a known issue cc: @allroundexperts

Onfido_unsupported.on.android.mp4

I see a warning on web that say one of the configuration optionuseLiveDocumentCapture is depreceted

Screenshot 2023-03-21 at 8 34 50 PM

Let me know what we can do about this other wise, PR tests well!

@allroundexperts
Copy link
Contributor Author

allroundexperts commented Mar 21, 2023 via email

@Santhosh-Sellavel
Copy link
Collaborator

Yes. I could not figure out the problems with Android. But it happens
without my changes.

Things like this should be brought forward also based on our checklist of PR fails(Unable to test) for android mWeb.

The Sooner you bring it faster we can move forward with a resolution.

@allroundexperts
Copy link
Contributor Author

Yes. I could not figure out the problems with Android. But it happens

without my changes.

Things like this should be brought forward also based on our checklist of PR fails(Unable to test) for android mWeb.

The Sooner you bring it faster we can move forward with a resolution.

Thanks for letting me know. Do I need to investigate this?

@Santhosh-Sellavel
Copy link
Collaborator

Yeah please or look whether this has been reported already?

@hayata-suenaga
Copy link
Contributor

@allroundexperts I saw you merged main into this PR. has the issue been solved on main?

@allroundexperts
Copy link
Contributor Author

@allroundexperts I saw you merged main into this PR. has the issue been solved on main?

@hayata-suenaga Not really. I can confirm that this issue is NOT happening when I open https://staging.new.expensify.com. However, on local host, this seems to cause an error even on the main branch. I'm still not able to find the root cause though. My guess is that it might be related to the browser security policy (since android opens localhost on 10.0.0.2).

@allroundexperts
Copy link
Contributor Author

Yeah please or look whether this has been reported already?

@Santhosh-Sellavel I couldn't find this reported anywhere. The closest I can find is this.

@hayata-suenaga
Copy link
Contributor

@allroundexperts when you got a moment, could you share the issue in #expensify-open-source channel in slack to see if anyone is encountering the same issue? I'd appreciate it.

@Santhosh-Sellavel
Copy link
Collaborator

I've just asked on bugs channels let's wait until EOD.

@allroundexperts
Copy link
Contributor Author

@allroundexperts when you got a moment, could you share the issue in #expensify-open-source channel in slack to see if anyone is encountering the same issue? I'd appreciate it.

@hayata-suenaga Posted now.

Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the error seems to be irrelevant to this PR, I think we're good to go!

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this one!

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hayata-suenaga Let's get this merged!

@hayata-suenaga hayata-suenaga merged commit f79a0ba into Expensify:main Mar 23, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.2.89-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants