fix: store reimbursement accounts separately per workspace

[samh-nl]

Details

Store reimbursement accounts separately per workspace.

Fixed Issues

$ #23480
PROPOSAL: #23480 (comment)

Tests

Precondition: The user has two workspaces with no bank account details set yet.

1. Go to Settings
2. Go to Workspaces
3. Go to Workspace A
4. Go to Bank account
5. Click Connect manually
6. Enter a routing number (912345581) and account number (3423431111)
7. Click Continue
8. Complete the remaining steps to add a bank account to the workspace
9. Go back to Workspaces
10. Go to Workspace B
11. Go to Bank account
12. Verify that two buttons are shown: Connect online with Plaid and Connect manually
13. Click Connect manually
14. Verify that the routing number and account number inputs are not prefilled with what was entered in Workspace A

• Verify that no errors appear in the JS console

Offline tests

1. Go to Settings
2. Go to Workspaces
3. Go to a workspace
4. Go to Bank account
5. Click Connect manually
6. Verify that the Continue button is disabled

QA Steps

Precondition: The user has two workspaces with no bank account details set yet.

1. Go to Settings
2. Go to Workspaces
3. Go to Workspace A
4. Go to Bank account
5. Click Connect manually
6. Enter a routing number (912345581) and account number (3423431111)
7. Click Continue
8. Complete the remaining steps to add a bank account to the workspace
9. Go back to Workspaces
10. Go to Workspace B
11. Go to Bank account
12. Verify that two buttons are shown: Connect online with Plaid and Connect manually
13. Click Connect manually
14. Verify that the routing number and account number inputs are not prefilled with what was entered in Workspace A

• 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 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 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

[melvin-bot]

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

[samh-nl]

Hi @parasharrajat, this is a draft PR as completely testing this functionality is not possible without backend changes.

High-level summary of changes

• ONYXKEYS.REIMBURSEMENT_ACCOUNT -> ONYXKEYS.COLLECTION.REIMBURSEMENT_ACCOUNT
• ONYXKEYS.REIMBURSEMENT_ACCOUNT_DRAFT -> ONYXKEYS.COLLECTION.REIMBURSEMENT_ACCOUNT_DRAFT
• The policy ID is appended to these Onyx keys

Requested backend change

Instead of reimbursementAccount Onyx data, the BE should return reimbursementAccount_(policyID).

Questions/remarks

I'd like to ask for your view on a few decisions that I've made while working on these changes:

1. Different consts for formID (but same value)

In ACHContractStep, BankAccountManualStep, BankAccountPlaidStep, CompanyStep and RequestorStep we currently use:
formID={ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM}

However, in ValidationStep we currently use:
formID={ONYXKEYS.REIMBURSEMENT_ACCOUNT}

They both have the same string value and we use the latter key elsewhere outside of forms, so for the sake of simplification and preventing duplicate Onyx keys, I removed the FORMS.REIMBURSEMENT_ACCOUNT_FORM key and used the other one.

2. I have added a new optional prop draftFormID to the Form component
Previously, the Onyx key for storing draft form values was determined by taking formID and appending 'Draft' to it:

App/src/libs/actions/FormActions.js

Lines 31 to 33 in ec7b267

	function setDraftValues(formID, draftValues) {
	Onyx.merge(`${formID}Draft`, draftValues);
	}

However, this is incompatible with storing reimbursement accounts as Onyx collections, as the policy ID is at the end of the Onyx key.

Example usage of this new prop:
draftFormID={`${ONYXKEYS.COLLECTION.REIMBURSEMENT_ACCOUNT_DRAFT}${this.props.policyID}`}

This ensures the correct Onyx key is used for storing the draft values. If the prop is not provided to the Form component nothing changes from its existing behavior, to ensure backwards-compatibility.

3. Removal of an unused component and a few functions
I have removed the ReimbursementAccountForm component, which was not referenced anywhere, as well as a few functions. These would otherwise also have to be changed, despite not being used.

[parasharrajat]

Different consts for formID (but same value)

use ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM

Removal of an unused component and a few functions

Please revert

I have added a new optional prop draftFormID to the Form component

Didn't get it.

[samh-nl]

Didn't get it.

Here is an example:

If you provide formID="reimbursementAccount" to Form, it will store the draft values in:

Onyx.merge(`${formID}Draft`, draftValues);

Which will use the reimbursementAccountDraft key.

However, as I've changed reimbursementAccount to a collection, i.e. reimbursementAccount_12345, this would become:
reimbursementAccount_12345Draft. Which is problematic.

Using the draftFormID prop, you can supply the correct Onyx key, which would be reimbursementAccountDraft_12345.

[parasharrajat]

However, as I've changed reimbursementAccount to a collection, i.e. reimbursementAccount_12345, this would become:
reimbursementAccount_12345Draft. Which is problematic.

Why did you convert it to the collection?

[samh-nl]

To allow appending the policy ID to the reimbursement account, preventing the data from spilling over between workspaces.

[parasharrajat]

I see. What if we use https://github.com/Expensify/react-native-onyx/blob/80c6f001e27e798ed56cc4f3a39ee27c5efae375/lib/Onyx.js#L142 to check if a key is collection and then append _ to the draft keyword inside the form.

[parasharrajat]

• Change the title to be more descriptive.
• Add Tests and QA tests.
• Add offline tests.
• Complete the checklist by following each item in it.

[samh-nl]

I see. What if we use https://github.com/Expensify/react-native-onyx/blob/80c6f001e27e798ed56cc4f3a39ee27c5efae375/lib/Onyx.js#L142 to check if a key is collection and then append _ to the draft keyword inside the form.

Yes, that sounds like a superior approach. I will work on its implementation.

[samh-nl]

With regards to using isCollectionMemberKey, the function is not exported from the library: see here.
I can re-implement it as a new util function, however this would not be an optimal solution. Am I allowed to make a PR there, so that it's exported and can be accessed via Onyx.isCollectionMemberKey?

[samh-nl]

Friendly bump

[samh-nl]

@parasharrajat Please provide an update, or if you are OOO, perhaps it can be re-assigned to another C+?

[parasharrajat]

Yeah, I wasn't much active the last 3 days. Going to review this today. It came out to be very big than what I expected which makes a difference as we didn't discuss the whole approach before moving to the PR.

[samh-nl]

It was decided to close this issue, so I'm closing the PR.