[HOLD for payment 2024-11-11] [$250] Approver - Existing approver settings reverts to default after upgrading workspace plan

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 9.0.49-1
Reproducible in staging?: Y
Reproducible in production?: Y
Email or phone of affected tester (no customers): [email protected]
Issue reported by: Applause Internal Team

Action Performed:

Precondition:

• Workspace is under Collect plan.
• Workspace has at least two members.

1. Go to staging.new.expensify.com
2. Go to workspace settings > Workflows.
3. Enable Add approvals.
4. Click on the existing approval workflow.
5. Click Approver.
6. Select another member as approver and save it.
7. Click Additional approver.
8. Upgrade the plan.
9. Click Got it, thanks.

Expected Result:

The existing approver settings in Step 6 will be preserved.

Actual Result:

The existing approver settings in Step 6 reverts to default after upgrading workspace plan.

Workaround:

Unknown

Platforms:

• Android: Standalone
• Android: HybridApp
• Android: mWeb Chrome
• iOS: Standalone
• iOS: HybridApp
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6636230_1729067871531.20241016_163338.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021847030936559806669
• Upwork Job ID: 1847030936559806669
• Last Price Increase: 2024-10-17
• Automatic offers:
• ishpaul777 | Reviewer | 104559184

Issue Owner

Current Issue Owner: @joekaufmanexpensify

[melvin-bot]

Triggered auto assignment to @joekaufmanexpensify (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.

[IuliiaHerets]

We think that this bug might be related to #wave-control

[IuliiaHerets]

@joekaufmanexpensify FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[bernhardoj]

Edited by proposal-police: This proposal was edited at 2024-10-16 17:02:28 UTC.

Proposal

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

Edit to the approval workflow is reset after upgrading the workspace from the additional approver flow.

What is the root cause of that problem?

When we go back from the upgrade page, we will call dismissModal which will dismiss the whole RHP including the ongoing edit approval flow.

App/src/pages/workspace/upgrade/WorkspaceUpgradePage.tsx

Lines 98 to 101 in 19b489c

	onBackButtonPress={() => {
	if (isUpgraded) {
	Navigation.dismissModal();
	goBack();

Then, we call goBack which navigates to the backTo params, in our case, the edit approval flow.

App/src/pages/workspace/upgrade/WorkspaceUpgradePage.tsx

Lines 39 to 46 in 19b489c

	switch (feature.id) {
	case CONST.UPGRADE_FEATURE_INTRO_MAPPING.reportFields.id:
	case CONST.UPGRADE_FEATURE_INTRO_MAPPING.rules.id:
	case CONST.UPGRADE_FEATURE_INTRO_MAPPING.companyCards.id:
	return Navigation.navigate(ROUTES.WORKSPACE_MORE_FEATURES.getRoute(policyID));
	default:
	return route.params.backTo ? Navigation.navigate(route.params.backTo) : Navigation.goBack();
	}

Because the page is closed and then reopened, the flow is restarted.

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

Don't always call dismissModal. For the approval feature, just go back and navigate with the fallback route. For all other existing cases, keep the dismissModal to not change the other existing behavior.

switch (feature.id) {
    case CONST.UPGRADE_FEATURE_INTRO_MAPPING.approvals.id:
        Navigation.goBack();
        if (route.params.backTo) {
            Navigation.navigate(route.params.backTo);
        }
        return;
    case CONST.UPGRADE_FEATURE_INTRO_MAPPING.reportFields.id:
    case CONST.UPGRADE_FEATURE_INTRO_MAPPING.rules.id:
    case CONST.UPGRADE_FEATURE_INTRO_MAPPING.companyCards.id:
        Navigation.dismissModal();
        return Navigation.navigate(ROUTES.WORKSPACE_MORE_FEATURES.getRoute(policyID));
    default:
        Navigation.dismissModal();
        return route.params.backTo ? Navigation.navigate(route.params.backTo) : Navigation.goBack();
}

Then, we can remove the dismissModal from here.

App/src/pages/workspace/upgrade/WorkspaceUpgradePage.tsx

Lines 99 to 111 in 19b489c

	if (isUpgraded) {
	Navigation.dismissModal();
	goBack();
	} else {
	Navigation.goBack();
	}
	}}
	/>
	{isUpgraded && (
	<UpgradeConfirmation
	onConfirmUpgrade={() => {
	Navigation.dismissModal();
	goBack();

[nkdengineer]

Proposal

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

The existing approver settings in Step 6 reverts to default after upgrading workspace plan.

What is the root cause of that problem?

After calling the UpgradeToCorporate function, we have updated the policy type and the Workflow.setApprovalWorkflow function will be called in this useEffect => it has reverted to default approver

App/src/pages/workspace/workflows/approvals/WorkspaceWorkflowsApprovalsEditPage.tsx

Lines 105 to 113 in fd2e0cb

	Workflow.setApprovalWorkflow({
	...currentApprovalWorkflow,
	availableMembers: [...currentApprovalWorkflow.members, ...defaultWorkflowMembers],
	usedApproverEmails,
	action: CONST.APPROVAL_WORKFLOW.ACTION.EDIT,
	isLoading: false,
	errors: null,
	});
	setInitialApprovalWorkflow(currentApprovalWorkflow);

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

We will not reset the approval workflow when the policy type changes.

    const policyType = policy?.type;
    const previousType = usePrevious(policy?.type);


   if(policyType !== previousType){
            Workflow.setApprovalWorkflow({
                ...currentApprovalWorkflow,
                availableMembers: [...currentApprovalWorkflow.members, ...defaultWorkflowMembers],
                usedApproverEmails,
                action: CONST.APPROVAL_WORKFLOW.ACTION.EDIT,
                isLoading: false,
                errors: null,
            });
        }

What alternative solutions did you explore? (Optional)

[joekaufmanexpensify]

Reproduced.

[melvin-bot]

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

[melvin-bot]

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

[joekaufmanexpensify]

Pending @ishpaul777 review of proposals

[ishpaul777]

Thanks for ping, i'll review in couple hours

[joekaufmanexpensify]

Great. TY!

[ishpaul777]

I swear i am on it today 🙇

[ishpaul777]

Proposal from @bernhardoj works well and LGTM!

🎀 👀 🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @MarioExpensify, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[MarioExpensify]

Very well, proposal looks good @bernhardoj!! Thank you @ishpaul777, let's move forward.

[melvin-bot]

📣 @ishpaul777 🎉 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

[bernhardoj]

PR is ready

cc: @ishpaul777

[joekaufmanexpensify]

PR in review

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.56-9 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Don't dismiss modal after workspace upgrade for approval case #51379

If no regressions arise, payment will be issued on 2024-11-11. 🎊

For reference, here are some details about the assignees on this issue:

• @bernhardoj requires payment through NewDot Manual Requests
• @ishpaul777 requires payment automatic offer (Reviewer)

[melvin-bot]

@ishpaul777 @joekaufmanexpensify The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

[joekaufmanexpensify]

Payment due next week! @ishpaul777 could you tackle checklist this week?

[joekaufmanexpensify]

Bumped in slack

[ishpaul777]

BugZero Checklist:

• [Contributor] Classify the bug:

Bug classification

Source of bug:

• 1a. Result of the original design (eg. a case wasn't considered)
• 1b. Mistake during implementation
• 1c. Backend bug
• 1z. Other:

Where bug was reported:

• 2a. Reported on production
• 2b. Reported on staging (deploy blocker)
• 2c. Reported on a PR
• 2z. Other:

Who reported the bug:

• 3a. Expensify user
• 3b. Expensify employee
• 3c. Contributor
• 3d. QA
• 3z. Other:

• [Contributor] 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: https://github.com/Expensify/App/pull/48673/files#r1836862383

• [Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source 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. Not critical, minor issue

  Link to discussion: No need

• [Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again.- Not required one time issue now solved.

[joekaufmanexpensify]

Will handle payment today

[joekaufmanexpensify]

Checklist is all set here. We need to pay:

• @bernhardoj - $250 for PR via NewDot.
• @ishpaul777 - $250 for C+ via Upwork.

[joekaufmanexpensify]

@ishpaul777 $250 sent and contract ended

[joekaufmanexpensify]

Upwork job closed.

[joekaufmanexpensify]

Closing as all that's left here is for @bernhardoj to request payment via NewDot. Please do this at your earliest convenience!

[bernhardoj]

Requested in ND.

[JmillsExpensify]

$250 approved for @bernhardoj