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

Clear Personal Bank Account Onyx keys in componentWillUnmount #15679

Merged
merged 8 commits into from
Mar 21, 2023

Conversation

MariaHCD
Copy link
Contributor

@MariaHCD MariaHCD commented Mar 6, 2023

Context: #15202 (comment)

This change ensures that we don't re-trigger the Plaid process once the user adds their PBA

Details

Fixed Issues

$ #15202
$ #15197
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Adding a PBA via Settings > Payments

  1. Sign in with any account that does not have an existing PBA
  2. Navigate to Settings > Payments > Add payment method > Bank account
  3. Add a PBA via Plaid
  4. On the PBA success page click Continue
  5. Observe that the Plaid flow is not triggered again

Adding a PBA via Sending Money

  1. Have a user account under the wallet beta, with a silver wallet and with no PBA set up
  2. Attempt to send money to another user
  3. Select Pay with Expensify > Bank Account
  4. Add a PBA via Plaid
  5. On the PBA success page click Continue
  6. Observe that the Plaid flow is not triggered again

Adding a PBA via deep link

  1. Sign out if already signed in
  2. Open https://localhost:8080/settings/payments/add-bank-account
  3. Sign in with any account that does not have an existing PBA
  4. Complete the plaid process and add a new account
  5. On Add bank account page, select the bank account and click Save & continue
  6. On the success page click Continue and verify the Plaid process is not triggered again

Offline tests

Not applicable

QA Steps

Same as test steps except they should be performed on staging

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

Via Settings > Payments

Screen.Recording.2023-03-06.at.5.59.28.PM.mov

Via sending money

Screen.Recording.2023-03-06.at.5.58.13.PM.mov

Via deep link

Screen.Recording.2023-03-06.at.6.11.46.PM.mov
Mobile Web - Chrome

Unable to test this platform as the redirect from Plaid leads to opening the native app

Mobile Web - Safari

Unable to test this platform as the redirect from Plaid leads to new.expensify.com

Desktop
Screen.Recording.2023-03-06.at.6.20.03.PM.mov
iOS
Screen.Recording.2023-03-06.at.6.25.20.PM.mov
Android
Screen.Recording.2023-03-06.at.6.52.56.PM.mov

@MariaHCD MariaHCD self-assigned this Mar 6, 2023
@MariaHCD MariaHCD marked this pull request as ready for review March 6, 2023 14:54
@MariaHCD MariaHCD requested a review from a team as a code owner March 6, 2023 14:54
@melvin-bot melvin-bot bot requested review from puneetlath and Santhosh-Sellavel and removed request for a team March 6, 2023 14:54
@MelvinBot
Copy link

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

@MariaHCD MariaHCD requested a review from nkuoch March 6, 2023 14:54
if ((this.props.receivedRedirectURI && this.props.plaidLinkOAuthToken)
|| !_.isEmpty(lodashGet(this.props.plaidData, 'bankAccounts'))
|| !_.isEmpty(lodashGet(this.props.plaidData, 'errors'))) {
|| !_.isEmpty(lodashGet(this.props.plaidData, 'errors'))
|| !_.isEmpty(this.props.selectedPlaidAccountID)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm do you know why we're re-entering this view in the first place? I wonder if the fix shouldn't happen outside of the view so this component doesn't get called.

Copy link
Collaborator

Choose a reason for hiding this comment

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

For the issue #15197 we are entering via deep-linking, directly using the URL so it makes sense.

But for another issue, I am confused too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm do you know why we're re-entering this view in the first place?

My theory is that when the user clicks the Continue button on the PBA success page, because we clear ONYXKEYS.PERSONAL_BANK_ACCOUNT, shouldShowSuccess evaluates to false and the AddPlaidBankAccount component is mounted again.

But I'm not 100% why it only happens during wallet KYC and via deep-linking.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know what you think, @nkuoch @Santhosh-Sellavel

Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need to clear details here?

onButtonPress={() => {
BankAccounts.clearPersonalBankAccount();
Navigation.navigate(ROUTES.SETTINGS_PAYMENTS);

Does it affect anything else, if it needs to be cleared we can do it at componentWillUnmount

@MariaHCD or @nkuoch

Copy link
Contributor

Choose a reason for hiding this comment

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

Good idea. I think we can remove BankAccounts.clearPersonalBankAccount(); from onButtonPress. The original idea was to make sure it's cleared for any next setup, but we already call it in componentDidMount, so it's probably useless here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, nice catch, @Santhosh-Sellavel! I think it would make sense to call it in componentWillUnmount. We're also calling it at componentDidMount but maybe it makes more sense to just have it in componentWillUnmount just so that there isn't any outdated data in the Onyx keys once the PBA is added. Thoughts?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree let me know when changes are done!

nkuoch
nkuoch previously approved these changes Mar 8, 2023
puneetlath
puneetlath previously approved these changes Mar 8, 2023
@Santhosh-Sellavel
Copy link
Collaborator

@MariaHCD I'll investigate this again, if no luck lets merge this tomorrow!

if ((this.props.receivedRedirectURI && this.props.plaidLinkOAuthToken)
|| !_.isEmpty(lodashGet(this.props.plaidData, 'bankAccounts'))
|| !_.isEmpty(lodashGet(this.props.plaidData, 'errors'))) {
|| !_.isEmpty(lodashGet(this.props.plaidData, 'errors'))
|| !_.isEmpty(this.props.selectedPlaidAccountID)) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need to clear details here?

onButtonPress={() => {
BankAccounts.clearPersonalBankAccount();
Navigation.navigate(ROUTES.SETTINGS_PAYMENTS);

Does it affect anything else, if it needs to be cleared we can do it at componentWillUnmount

@MariaHCD or @nkuoch

@Santhosh-Sellavel
Copy link
Collaborator

bump @MariaHCD @nkuoch

@MariaHCD MariaHCD dismissed stale reviews from puneetlath and nkuoch via b38bd78 March 17, 2023 22:33
@MariaHCD
Copy link
Contributor Author

Apologies for the delay here! Updated and re-tested!

@MariaHCD MariaHCD changed the title Don't re-trigger the Plaid process if we already have a selected Plaid account Clear Personal Bank Account Onyx keys in componentWillUnmount Mar 17, 2023
@Santhosh-Sellavel
Copy link
Collaborator

Console errors on native while adding account Screenshot 2023-03-20 at 1 07 14 AM Screenshot 2023-03-20 at 1 06 49 AM Screenshot 2023-03-20 at 1 06 28 AM Screenshot 2023-03-20 at 1 06 13 AM
Screen.Recording.2023-03-20.at.1.04.06.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Mar 19, 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

Web & Mobile Web - Chrome & Mobile Web - Safari

Unable to test due CORS

Desktop
Screen.Recording.2023-03-20.at.1.42.39.AM.mov
iOS & Android
Screen.Recording.2023-03-20.at.1.04.06.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Mar 19, 2023

Adding a PBA via Settings > Payments - ✅ Pass

Adding a PBA via deep link -> Payments - ✅ Pass

Adding a PBA via Sending Money -> Anyone tests this case

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.

LGTM, test well!

Adding a PBA via Sending Money - Anyone tests this case alone thanks!

cc: @puneetlath or @nkuoch

@nkuoch
Copy link
Contributor

nkuoch commented Mar 21, 2023

Adding a PBA via Sending Money -> ✅ Pass

@nkuoch nkuoch merged commit ec2990b into main Mar 21, 2023
@nkuoch nkuoch deleted the maria-fix-plaid-retrigger branch March 21, 2023 12:36
@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/nkuoch in version: 1.2.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.2.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.2.88-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.2.88-2 🚀

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.

6 participants