[HOLD for payment 2024-09-10] [$250] Workspace - RBRs displayed on every workspace after quitting adding bank VBA & starting over

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number: 9.0.25-10
Reproducible in staging?: Y
Reproducible in production?: unable to check
Issue was found when executing this PR: #47841
Issue reported by: Applause Internal Team

Action Performed:

1. Open the app and log in with the account that has several workspaces
2. Navigate to workspace settings > More features
3. Enable workflows
4. Open workflows > Connect bank account
5. Select "Connect online with Plaid"
6. Select Regions and continued adding VBA
7. Quit the flow half way
8. Navigate to Workflows > Connect bank account
9. Select start over
10. Navigate to the list of workspaces

Expected Result:

There should not be no RBRs

Actual Result:

The RBR is displayed on every workspace

Workaround:

Unknown

Platforms:

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6584835_1724812499936.Recording__725.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0180cfb0a524c49cdc
• Upwork Job ID: 1828775893654614402
• Last Price Increase: 2024-08-28
• Automatic offers:
• paultsimura | Reviewer | 103721395
• NJ-2020 | Contributor | 103721396

Issue Owner

Current Issue Owner: @garrettmknight

[melvin-bot]

Triggered auto assignment to @dangrous (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[melvin-bot]

Triggered auto assignment to @garrettmknight (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[IuliiaHerets]

We think that this bug might be related to #wave-collect - Release 1

[NJ-2020]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Workspace - RBRs displayed on every workspace after quitting adding bank VBA & starting over

What is the root cause of that problem?

When we quit when adding the bank details in half way, then trying to reconnect and click start over, the reimbursement account (bank account) errors returning empty object
So when we check here if there's any error, empty object will return true

App/src/pages/workspace/WorkspacesListPage.tsx

Line 309 in 1bb1131

const reimbursementAccountBrickRoadIndicator = reimbursementAccount?.errors ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;

What changes do you think we should make in order to solve the problem?

We can replace the reimbursementAccount?.errors to !isEmptyObject(reimbursementAccount?.errors) to check if it's not an empty object and also the type of the reimbursementAccount?.errors is Record<string, string | null>
So we will change from:

const reimbursementAccountBrickRoadIndicator = reimbursementAccount?.errors ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;

To:

const reimbursementAccountBrickRoadIndicator = !isEmptyObject(reimbursementAccount?.errors) ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined;

What alternative solutions did you explore? (Optional)

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0180cfb0a524c49cdc

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @paultsimura (External)

[garrettmknight]

Reproduced, opening up. @dangrous I'm not 100% sure we need to block the deploy for this one since it's a pretty niche issue and ultimately a UI issue so far as I can tell. What do you think?

[Nodebrute]

Edited by proposal-police: This proposal was edited at 2024-08-28 13:05:27 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Workspace - RBRs displayed on every workspace after quitting adding bank VBA & starting over

What is the root cause of that problem?

When we call resetFreePlanBankAccount in success data we add DEFAULT_DATA in which we have errors: {}, So whenever we check for reimbursementAccount?.errors, it will evaluate to true because it's an empty object.

App/src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

Lines 78 to 81 in 1bb1131

	{
	onyxMethod: Onyx.METHOD.SET,
	key: ONYXKEYS.REIMBURSEMENT_ACCOUNT,
	value: CONST.REIMBURSEMENT_ACCOUNT.DEFAULT_DATA,

App/src/CONST.ts

Lines 4468 to 4478 in 1bb1131

	REIMBURSEMENT_ACCOUNT: {
	DEFAULT_DATA: {
	achData: {
	state: BankAccount.STATE.SETUP,
	},
	isLoading: false,
	errorFields: {},
	errors: {},
	maxAttemptsReached: false,
	shouldShowResetModal: false,
	},

What changes do you think we should make in order to solve the problem?

In default data we can either remove errors and errorfields or we can set them to null

App/src/CONST.ts

Lines 4468 to 4478 in 1bb1131

	REIMBURSEMENT_ACCOUNT: {
	DEFAULT_DATA: {
	achData: {
	state: BankAccount.STATE.SETUP,
	},
	isLoading: false,
	errorFields: {},
	errors: {},
	maxAttemptsReached: false,
	shouldShowResetModal: false,
	},

            errorFields: null,
            errors: null,

Note: removing errorFields is optional. This error can also be resolved by only removing errors or setting it to null

What alternative solutions did you explore? (Optional)

In backend response the data is set to null in success data we can also remove this

App/src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

Lines 78 to 82 in 1bb1131

	{
	onyxMethod: Onyx.METHOD.SET,
	key: ONYXKEYS.REIMBURSEMENT_ACCOUNT,
	value: CONST.REIMBURSEMENT_ACCOUNT.DEFAULT_DATA,
	},

[paultsimura]

Reviewing now 👀

[paultsimura]

The proposal by @NJ-2020 looks good to me.

We use the same check here:

App/src/pages/workspace/WorkspaceInitialPage.tsx

Line 220 in a2645b5

brickRoadIndicator: !isEmptyObject(reimbursementAccount?.errors) ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : undefined,

🎀👀🎀 C+ reviewed

[melvin-bot]

Current assignee @dangrous is eligible for the choreEngineerContributorManagement assigner, not assigning anyone new.

[Nodebrute]

Hwy @paultsimura, thanks for the review! I appreciate the feedback, but I think using isEmptyObject might be more of a workaround. When we're starting over, we don't need errors:{}. This approach is similar to how we handle other default data.

App/src/CONST.ts

Lines 1121 to 1122 in dc5aaeb

	DEFAULT_ACCOUNT_DATA: {errors: null, success: '', isLoading: false},
	DEFAULT_CLOSE_ACCOUNT_DATA: {errors: null, success: '', isLoading: false},

[paultsimura]

@Nodebrute we use errors: {} as a default value in other places related to banking:

App/src/pages/EnablePayments/AdditionalDetailsStep.tsx

Line 33 in 7dae918

errors: {},

App/src/pages/EnablePayments/OnfidoPrivacy.tsx

Line 26 in 8510c65

errors: {},

IMO, we should stick to it and fix the RBR handling as in the selected proposal.

[Nodebrute]

@paultsimura Thank you for clarifying. I appreciate it!

[dangrous]

works for me! assigning @NJ-2020

[melvin-bot]

📣 @paultsimura 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[melvin-bot]

📣 @NJ-2020 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[NJ-2020]

PR Ready

cc: @paultsimura

[paultsimura]

Deployed to production: #48231 (comment)
Payment is due on Sep 10

[paultsimura]

• The PR that introduced the bug has been identified. Link to the PR: [Wave 8] Ideal nav  #33280
• The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: 84071e8#r146382434
• A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: N/A
• Determine if we should create a regression test for this bug: Yes
• If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.

Regression Test Proposal

1. Open the app and log in with the account that has several workspaces
2. Navigate to workspace settings > More features
3. Enable workflows
4. Open workflows > Connect bank account
5. Select "Connect online with Plaid"
6. Select "Regions bank" and continue adding VBA
7. Quit the flow half-way
8. Navigate to Workflows > Connect bank account
9. Select "start over"
10. Navigate to the list of workspaces
11. Verify that there's no RBR in the workspaces list

Do we agree 👍 or 👎

[garrettmknight]

Payment Summary:

• Contributor: @NJ-2020 $250 paid via Upwork
• Reviewer: @paultsimura $250 paid via Upwork