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

feature: Add validation flow to bank account set up #38726

Merged
merged 6 commits into from
Jun 7, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Mar 21, 2024

Details

Fixed Issues

$ #33035
PROPOSAL: #33035 (comment)

Tests

  1. Create an unvalidated account on New Expensify by logging into expensify.com with an account on a public domain
  2. Create a workspace for that account
  3. Navigate to your Workspace >
  4. Select either Connect Online With Plaid or Connect Manually
  5. Verify that: User should see a page with a view to validate their account and receive a notification to validate their bank account.
  6. Pressing the < should take them back to the Connect Bank Account with the two options mentioned in step 4.
  7. Once the user verifies their account they should be able to continue with the standard bank account setup flow
  • It is expected that at this time the user will be logged out shortly after validating their account through this flow.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Create an unvalidated account on New Expensify by logging into expensify.com with an account on a public domain
  2. Create a workspace for that account
  3. Navigate to your Workspace >
  4. Select either Connect Online With Plaid or Connect Manually
  5. Verify that: User should see a page with a view to validate their account and receive a notification to validate their bank account.
  6. Pressing the < should take them back to the Connect Bank Account with the two options mentioned in step 4.
  7. Once the user verifies their account they should be able to continue with the standard bank account setup flow
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
android-mweb-resize.mp4
iOS: Native
iOS: mWeb Safari
ios-mweb.mov
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
desktop-resize.mp4

@dukenv0307 dukenv0307 marked this pull request as ready for review May 20, 2024 09:19
@dukenv0307 dukenv0307 requested a review from a team as a code owner May 20, 2024 09:19
@melvin-bot melvin-bot bot removed the request for review from a team May 20, 2024 09:19
Copy link

melvin-bot bot commented May 20, 2024

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

@dukenv0307
Copy link
Contributor Author

@allroundexperts I screenshotted all platforms except Android and iOS.
How can we login with an unvalidated account on iOS and Android?

@allroundexperts
Copy link
Contributor

allroundexperts commented May 23, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native

N/A

Android: mWeb Chrome
Screen.Recording.2024-05-23.at.5.15.50.PM.mov
iOS: Native

N/A

iOS: mWeb Safari
Screen.Recording.2024-05-23.at.5.10.01.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-23.at.4.48.45.PM.mov
MacOS: Desktop
Desktop.Recording.mov

@allroundexperts
Copy link
Contributor

BUG

On going back after verification, you get logged out automatically.

Screen.Recording.2024-05-23.at.4.54.19.PM.mov

@dukenv0307
Copy link
Contributor Author

On going back, ReconnectApp API is called with params as null, and then we logout automatically. Do you think we should fix this as a separate issue.

@allroundexperts
Copy link
Contributor

This seems connected to me. To make things faster, maybe we can request a bounty increase instead of creating a separate issue.

@dukenv0307
Copy link
Contributor Author

@allroundexperts It's a backend issue. After we validate the account, if we call any other API, BE returns that the session has expired.

Screen.Recording.2024-05-28.at.16.14.36.mov
Screen.Recording.2024-05-28.at.16.17.14.mov

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented May 28, 2024

To fix this issue I think when we validate the default contact method, BE should return a new authToken or not expire the current token of the user cc @NikkiWines

@allroundexperts
Copy link
Contributor

@NikkiWines Can you check if this can be fixed from the backend?

@NikkiWines
Copy link
Contributor

Yep, I'll take a look today!

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good other than the logout issue which seems to be related to the backend. @NikkiWines is investigating that.

@melvin-bot melvin-bot bot requested a review from NikkiWines May 30, 2024 17:22
@NikkiWines
Copy link
Contributor

Coincidentally, it looks like we have an open PR to resolve this bug as part of a different issue - #35791

@hayata-suenaga do you have an ETA for that PR by any chance?

@allroundexperts
Copy link
Contributor

I think we can merge this since the bug is un-related to this PR.

@hayata-suenaga
Copy link
Contributor

That PS was in my backlog. Seems like this PR is not related to my PR 😄

@dukenv0307
Copy link
Contributor Author

I think we can merge this since the bug is un-related to this PR.

@NikkiWines What do you think about this?

@NikkiWines
Copy link
Contributor

@hayata-suenaga it is related to your PR (though unbeknownst to you until now) as the functionality you added in https://github.com/Expensify/Web-Expensify/pull/41180 is being utilized as part of this new feature.

However, agreed with @allroundexperts that we can merge this PR as is since the sign-out issue is already known will presumably be fixed with #35791.

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

Looks good though clicking on the verify the account link the first time fails to redirect the user appropriately.

After that it works fine though 👍

Screen.Recording.2024-06-05.at.22.19.20.mov

phrase2: 'sign back in with a magic code',
phrase2: 'sign back in with a magic code ',
phrase3: 'or ',
phrase4: 'verify the account here',
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's change this to verify your account here (and also update the Spanish copy accordingly)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@NikkiWines I updated.

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

Works great aside from the aforementioned log out issue.

@NikkiWines NikkiWines merged commit fbd51e4 into Expensify:main Jun 7, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 7, 2024

✋ 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 production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

@etCoderDysto
Copy link
Contributor

Hi @dukenv0307, I am working on extracting the component you have built here and use it on 2FA page when user is not validated. I am facing this navigation issue while trying to use the component on CodeStep of 2FA page. For the past few days, I have been trying to investigate the issue to no avail. Could you please help me understand the issue? Thank you!

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.

6 participants