Fix no error shows when saving personal bank account that exist in workspace BA draft by bernhardoj · Pull Request #39398 · Expensify/App

bernhardoj · 2024-04-02T10:43:47Z

Details

In personal bank account page, the form key doesn't match the key we use to save the error (and loading state), so the error (and loading) is never shown. This PR fixes it by using the correct key.

Fixed Issues

$ #38518
PROPOSAL: #38518 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: have an ongoing bank account setup in workspace bank account

Go to Wallet > Add bank account > Personal bank account
Select any bank and complete the plaid step
Select Plaid Saving account (ends with 1111)
Click Save
Verify there is a loading indicator on the button
Verify an error (Bank account can't be created...) is shown after the loading completes

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-02.at.18.25.56.mov

Android: mWeb Chrome

Screen.Recording.2024-04-02.at.19.53.49.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-04-02.at.18.30.20.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-02.at.18.21.09.mov

MacOS: Desktop

Screen.Recording.2024-04-02.at.18.23.20.mov

melvin-bot · 2024-04-02T10:43:52Z

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

bernhardoj · 2024-04-02T10:45:12Z

I accidentally comitted unrelated files, so I force pushed.

bernhardoj · 2024-04-02T10:46:34Z

~~I get too much attempt when testing on android mWeb.~~ solved

I can't access the plaid sandbox on iOS native.

jakub-trzebiatowski · 2024-04-02T11:30:38Z

TypeScript Checks

bernhardoj · 2024-04-02T11:36:47Z

src/pages/AddPersonalBankAccountPage.tsx

 AddPersonalBankAccountPage.displayName = 'AddPersonalBankAccountPage';

 export default withOnyx<AddPersonalBankAccountPageWithOnyxProps, AddPersonalBankAccountPageWithOnyxProps>({
+    // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT


Looks like the type is conflicting. We did this for all reimbursement account step.

App/src/pages/ReimbursementAccount/PersonalInfo/PersonalInfo.tsx

Lines 98 to 102 in bf1ec5a

export default withOnyx<PersonalInfoProps, PersonalInfoOnyxProps>({

// @ts-expect-error: ONYXKEYS.REIMBURSEMENT_ACCOUNT is conflicting with ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM

reimbursementAccount: {

key: ONYXKEYS.REIMBURSEMENT_ACCOUNT,

},

@blazejkustra Do you have any idea how we could solve this without expecting errors?

Yes, we should not conflict onyx keys:

/** Stores information about the active personal bank account being set up */ PERSONAL_BANK_ACCOUNT: 'personalBankAccount', FORMS: { PERSONAL_BANK_ACCOUNT: 'personalBankAccountForm', // different than 'personalBankAccount' PERSONAL_BANK_ACCOUNT_DRAFT: 'personalBankAccountFormDraft', }

PERSONAL_BANK_ACCOUNT and FORMS.PERSONAL_BANK_ACCOUNT should have different values. If not we have to use ts-expect-error 😒

Yeah, but apparently, the backend expects this key to be personalBankAccount. This is the reason why we don't apply the *Form suffix to all keys.

I think we should do something systematic here. Either drop the assumption about unique keys or adjust the backend.

@blazejkustra Do you think the first one is possible/reasonable?
@Gonals How would you assess the difficulty of adjusting the backend?

I know that changing the backend because of the fronend typing might feel counterintuitive, but from my perspective, it's about designing a consistent Onyx key system, taking all practical aspects into consideration. We should decide whether key uniqueness should or shouldn't be a requirement in this system, and then adjust whatever needs to be adjusted.

Do you think the first one is possible/reasonable?

It's possible, because we already have some keys that aren't unique. But this comes with a lot of ts-expect-errors in the code. We could overcome this by defining a common type for both personal bank account and personal bank account form, but this would require a big refactor across the codebase due to conflicts in these two types.

It's not reasonable, without unique keys we would compromise on types because a key could be either a PersonalDetailsForm type or PersonalDetails and this would create a big mess inside components (try it for yourself 😅)

I understand Expensify has other priorities at the moment, but the best approach would be to fix this on the backend side and keep keys unique.

bernhardoj · 2024-04-02T11:41:57Z

src/libs/actions/BankAccounts.ts

+            // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT
            {
                onyxMethod: Onyx.METHOD.MERGE,
                key: ONYXKEYS.PERSONAL_BANK_ACCOUNT,


This also conflicts because of the errors property. It expects to be FormValue | null | undefined, but the error type is OnyxCommon.Errors.

App/src/types/form/Form.ts

Lines 4 to 16 in bf1ec5a

type BaseForm = {

/** Controls the loading state of the form */

isLoading?: boolean;

/** Server side errors keyed by microtime */

errors?: OnyxCommon.Errors | null;

/** Field-specific server side errors keyed by microtime */

errorFields?: OnyxCommon.ErrorFields | null;

};

type FormValues<TInputs extends string> = Record<TInputs, FormValue>;

type Form<TInputs extends string = string, TFormValues extends FormValues<TInputs> = FormValues<TInputs>> = TFormValues & BaseForm;

If we don't pass anything to TInputs, then the value type is expected to be FormValue. If I pass any value to it, then the type error is gone.

App/src/types/form/PersonalBankAccountForm.ts

Line 3 in bf1ec5a

type PersonalBankAccountForm = Form;

type PersonalBankAccountForm = Form<"test">

bernhardoj · 2024-04-02T11:49:59Z

Additional video showing that it still works in a normal case.

Screen.Recording.2024-04-02.at.19.49.13.mov

jakub-trzebiatowski · 2024-04-02T12:10:35Z

src/libs/actions/BankAccounts.ts

            },
        ],
        failureData: [
+            // @ts-expect-error: ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT


I don't understand why we need both these keys; could you explain it to me? I thought that keeping both was the original human mistake here and the cause of all the trouble.

I think it's mainly for type and convention. The FormProvider formID expects the value to be one of the keys of OnyxFormValuesMapping type,

App/src/ONYXKEYS.ts

Line 494 in a1801c8

[ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT]: FormTypes.PersonalBankAccountForm;

and the type for ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT is FormTypes.PersonalBankAccountForm. I think it would be weird if I change the type to be OnyxTypes.PersonalBankAccount.

And we can't switch to just ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT, right?

Why can't we? By "switch" I mean start using ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT where we now use ONYXKEYS.PERSONAL_BANK_ACCOUNT. Are there also some typing constraints here?

Oh, I thought you mean to use ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT with the old value (personalBankAccountForm).

We can but the type error still exists without ignoring it.

Okey, so maybe I'm misunderstanding the error.

ONYXKEYS.PERSONAL_BANK_ACCOUNT is conflicting with ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT

If ONYXKEYS.PERSONAL_BANK_ACCOUNT didn't exist (because we replaced all usages with the new key, ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT and deleted ONYXKEYS.PERSONAL_BANK_ACCOUNT itself ), than how would it conflict?

I explained it briefly in the previous comment here.

Here is the type of the onyx update:

The KeyValueMapping type includes this custom type:

App/src/types/modules/react-native-onyx.d.ts

Lines 6 to 10 in 7446c1a

interface CustomTypeOptions {

keys: OnyxValueKey | OnyxFormKey | OnyxFormDraftKey;

collectionKeys: OnyxCollectionKey;

values: OnyxValues;

}

The OnyxValues contains the type for both ONYXKEYS.PERSONAL_BANK_ACCOUNT (PersonalBankAccount) and ONYXKEYS.FORMS.PERSONAL_BANK_ACCOUNT (PersonalBankAccountForm).

App/src/ONYXKEYS.ts

Line 642 in 7446c1a

type OnyxValues = OnyxValuesMapping & OnyxCollectionValuesMapping & OnyxFormValuesMapping & OnyxFormDraftValuesMapping;

Because the key is the same (personalBankAccount, both types are used)

I have tried doing this:

type PersonalBankAccountForm = Form & PersonalBankAccount;

But still get the error.

I've inspected the code; please disregard my previous suggestions. I underestimated how much is going on here type-wise.

jakub-trzebiatowski · 2024-04-10T13:02:49Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

jakub-trzebiatowski · 2024-04-10T13:03:14Z

@bernhardoj Would you solve the conflicts?

bernhardoj · 2024-04-10T15:50:56Z

It's conflicted with #39038, I'll check it more tomorrow.

bernhardoj · 2024-04-11T06:23:40Z

src/libs/actions/BankAccounts.ts

 function clearPersonalBankAccount() {
    clearPlaid();
-    Onyx.set(ONYXKEYS.PERSONAL_BANK_ACCOUNT, {});
+    Onyx.set(ONYXKEYS.PERSONAL_BANK_ACCOUNT, null);


Changed this to null to fix the type. Every usage of personalBankAccount already uses a null safety, so it's safe.

bernhardoj · 2024-04-11T06:28:42Z

@cubuspl42 I have retested this PR and the test step from #39038 and everything still seems works fine.

jakub-trzebiatowski · 2024-04-11T07:55:17Z

@Gonals The typing situation is far from perfect here, but it's not trivial to fix it. Please see this comment for context.

OSBotify · 2024-04-11T11:27:27Z

✋ 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 · 2024-04-18T04:55:53Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:56:52Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

bernhardoj requested a review from a team as a code owner April 2, 2024 10:43

melvin-bot bot requested review from jakub-trzebiatowski and removed request for a team April 2, 2024 10:43

use the correct key

b014e37

bernhardoj force-pushed the fix/38518-no-error-whne-try-to-save-existing-ba branch from 80fa57a to b014e37 Compare April 2, 2024 10:44

suppress typecheck

fb723f7

bernhardoj commented Apr 2, 2024

View reviewed changes

jakub-trzebiatowski reviewed Apr 2, 2024

View reviewed changes

bernhardoj added 2 commits April 10, 2024 23:36

Merge branch 'main' into fix/38518-no-error-whne-try-to-save-existing-ba

076c66c

fix typing after conflict

3e5629b

bernhardoj added 2 commits April 11, 2024 14:02

Merge branch 'main' into fix/38518-no-error-whne-try-to-save-existing-ba

bc77501

set to null

40a9e2d

bernhardoj commented Apr 11, 2024

View reviewed changes

jakub-trzebiatowski approved these changes Apr 11, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals April 11, 2024 07:54

Gonals approved these changes Apr 11, 2024

View reviewed changes

Gonals merged commit 0f4da45 into Expensify:main Apr 11, 2024

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

	export default withOnyx<PersonalInfoProps, PersonalInfoOnyxProps>({
	// @ts-expect-error: ONYXKEYS.REIMBURSEMENT_ACCOUNT is conflicting with ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM
	reimbursementAccount: {
	key: ONYXKEYS.REIMBURSEMENT_ACCOUNT,
	},

	type BaseForm = {
	/** Controls the loading state of the form */
	isLoading?: boolean;

	/** Server side errors keyed by microtime */
	errors?: OnyxCommon.Errors \| null;

	/** Field-specific server side errors keyed by microtime */
	errorFields?: OnyxCommon.ErrorFields \| null;
	};

	type FormValues<TInputs extends string> = Record<TInputs, FormValue>;
	type Form<TInputs extends string = string, TFormValues extends FormValues<TInputs> = FormValues<TInputs>> = TFormValues & BaseForm;

	interface CustomTypeOptions {
	keys: OnyxValueKey \| OnyxFormKey \| OnyxFormDraftKey;
	collectionKeys: OnyxCollectionKey;
	values: OnyxValues;
	}

Conversation

bernhardoj commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 2, 2024

Uh oh!

bernhardoj commented Apr 2, 2024

Uh oh!

bernhardoj commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakub-trzebiatowski commented Apr 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blazejkustra Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blazejkustra Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Apr 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernhardoj Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski commented Apr 10, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

jakub-trzebiatowski commented Apr 10, 2024

Uh oh!

bernhardoj commented Apr 10, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Apr 11, 2024

Uh oh!

jakub-trzebiatowski commented Apr 11, 2024

Uh oh!

OSBotify commented Apr 11, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Reviewers

Assignees

bernhardoj commented Apr 2, 2024 •

edited

Loading

bernhardoj commented Apr 2, 2024 •

edited

Loading

blazejkustra Apr 3, 2024 •

edited

Loading

blazejkustra Apr 3, 2024 •

edited

Loading

bernhardoj Apr 2, 2024 •

edited

Loading