App icon indicating copy to clipboard operation
App copied to clipboard

Fix Default Bank Account Tagging Issue

Open brunovjk opened this issue 1 year ago • 11 comments

Details

Resolves the presence of two default marked bank accounts by setting isDefault to false for all other bank accounts in onyx when the AddPersonalBankAccount response is successful.

Fixed Issues

$ https://github.com/Expensify/App/issues/34774 PROPOSAL: $ https://github.com/Expensify/App/issues/34774#issuecomment-1911164240

Tests

  1. Open Expensify App
  2. Log in
  3. Navigate to Settings - Wallet
  4. Add a bank account for example Chasebank
  5. Repeat step 4 with another bank account
  6. Only one Default tagged bank account should exist
  • [x] Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests.

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/Expensify/App/assets/95647348/fb489c49-416d-4e83-8b30-b598bb07241a

Android: mWeb Chrome

https://github.com/Expensify/App/assets/95647348/48d43f29-ca2c-43f0-aa10-5a6a67da11b5

iOS: Native

https://github.com/Expensify/App/assets/95647348/370ed477-9d99-45ae-a9a7-e2e8c2e1e4f1

iOS: mWeb Safari

https://github.com/Expensify/App/assets/95647348/9d4e631c-3926-4b08-9cc3-53a08610486f

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/95647348/caabd9b4-bfba-4891-8786-ac6f5608fbe7

MacOS: Desktop

https://github.com/Expensify/App/assets/95647348/0c3d0dbb-7f8c-42f9-a270-341900736bda

brunovjk avatar Jan 31 '24 22:01 brunovjk

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

melvin-bot[bot] avatar Jan 31 '24 22:01 melvin-bot[bot]

@s77rt I wonder what happens and what should happen when the user deletes a bank account. Using user_good I can register only 2 accounts, but what happens if the user has 3 registered accounts and deletes the account that has the default tag? The tag goes to: A - the last account added B - the last account with the default tag (example if the user changes manually) C - no default tag With the implementation of this PR I believe that the option C will be the behavior. Maybe we need to change the successData of deletePaymentBankAccount too. What do you think?

brunovjk avatar Feb 01 '24 16:02 brunovjk

Upon testing I found that the BE doesn't always return the new bank as default. In such case this PR would cause a regression where no bank account is marked as default. Also I noticed that now once we complete the bank account flow OpenPaymentsPage is called which fixes the default tag.

I think doing nothing is best here. Or we can fix this in the BE, sending one more bank account in AddPersonalBankAccount response is not much overhead (new bank account + old default bank account in case the new one is set as default)

cc @stitesExpensify

https://github.com/Expensify/App/assets/16493223/1ec00925-3400-4534-aa85-470dc1da91b2

s77rt avatar Feb 04 '24 16:02 s77rt

@s77rt You're right, I thought that BE always returns an isDefault value equal to true to the latest added bank account. This PR do not achieve the proposition "to set isDefault to false for all other bank accounts in onyx if our response has isDefault as true". I believe it is hard, but not impossible, to do it, since we will only know if isDefault is true after the BE response.

I tried to reproduce it in the latest main and after the OpenPaymentsPage calling the related issue is indeed resolved. But it's still not perfect in my opinion, take a look please:

Showing two default tag before `OpenPaymentsPage` call

https://github.com/Expensify/App/assets/95647348/a898043c-3c93-469f-a0ef-c53b54ffdfbf

Maybe use the logic of this PR from successData to optimisticData?

brunovjk avatar Feb 04 '24 18:02 brunovjk

I think doing nothing is best here.

Is an option heheh. We can't forget to ''Handle the double 'PaymentMethods.openWalletPage()' call". Perhaps an intern can raise a PR later.

brunovjk avatar Feb 04 '24 18:02 brunovjk

@brunovjk Using successData or optimisticData does not make much difference. We will still be clearing the default account even in cases where we shouldn't

s77rt avatar Feb 04 '24 23:02 s77rt

I see, it makes perfect sense.

Showing two default tag before OpenPaymentsPage call

But do you think there is something we can do to improve this?

brunovjk avatar Feb 05 '24 01:02 brunovjk

I think BE approach can handle that

s77rt avatar Feb 05 '24 14:02 s77rt

Awesome! If works Im fine with that :D

brunovjk avatar Feb 05 '24 14:02 brunovjk

To clarify @s77rt are you recommending that we do not move forward with this PR and go for a purely backend solution instead?

stitesExpensify avatar Feb 06 '24 19:02 stitesExpensify

@stitesExpensify Yes!

s77rt avatar Feb 06 '24 22:02 s77rt

Please ignore these commits, I was doing some testing.

brunovjk avatar Feb 14 '24 20:02 brunovjk

hello @s77rt, stitesExpensify is working on the BE solution, I have a thought, more for the sake of learning than actually doing something. Do you think we would manage to "set isDefault to false for all other bank accounts in onyx if and only if our response has isDefault as true."? In other words, wait for BE's response to change the BankList afterwards? Thank's for your time.

brunovjk avatar Feb 14 '24 20:02 brunovjk

@brunovjk We can achieve that using makeRequestWithSideEffects but this is used only as the last ressort as it's discouraged.

s77rt avatar Feb 15 '24 14:02 s77rt

Nice, good to know :D thank you very much @s77rt.

brunovjk avatar Feb 15 '24 14:02 brunovjk

Closing this since we are going with a backend solution.

brunovjk avatar Feb 19 '24 13:02 brunovjk