[HOLD for payment 2024-07-24] [$250] QBO - "Required" remains enabled when all tags are disabled

[lanitochka17]

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: 1.4.83-0
Reproducible in staging?: Y
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Issue reported by: Applause - Internal Team

Issue found when executing PR #42972

Action Performed:

Precondition:

• Account is connected to QBO

1. Go to staging.new.expensify.com
2. Go to workspace settings
3. Go to Tags
4. Click Classes
5. Toggle on Required
6. Select all tags
7. Disable all tags

Expected Result:

"Required" will be disabled and locked when all tags are disabled (same behavior when all categories are disabled)

Actual Result:

"Required" remains enabled when all tags are disabled

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6512016_1718287352585.20240613_215711.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01f4ad944ec831b5b7
• Upwork Job ID: 1801300917150271805
• Last Price Increase: 2024-06-13
• Automatic offers:
• akinwale | Reviewer | 102740102
• Krishna2323 | Contributor | 102740104

Issue Owner

Current Issue Owner: @akinwale

[melvin-bot]

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

[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.

[lanitochka17]

@cead22 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

[melvin-bot]

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

[melvin-bot]

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

[cretadn22]

Proposal

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

"Required" remains enabled when all tags are disabled

What is the root cause of that problem?

We don't implement the logic to toggle off currentPolicyTag?.required if all tags is disabled

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

When the disableTag button is clicked, we must verify if all tags are currently disabled.

App/src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

Lines 176 to 179 in 595967d

	onSelected: () => {
	setSelectedTags({});
	Tag.setWorkspaceTagEnabled(policyID, tagsToDisable, route.params.orderWeight);
	},

If if all tags are currently disabled, we need to turn off currentPolicyTag?.required by adding

Tag.setPolicyTagsRequired(policyID, false, route.params.orderWeight)

Bonus point 1: Also consider toggling off currentPolicyTag?.required when all tags are deleted

Bonus point 2: Also consider toggling on currentPolicyTag?.required when at least one tag is enabled again

What alternative solutions did you explore? (Optional)

[Krishna2323]

Proposal

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

QBO - "Required" remains enabled when all tags are disabled

What is the root cause of that problem?

We don't update the required state of the tag list based on numbers enabled/disabled tags.

App/src/libs/actions/Policy/Tag.ts

Line 181 in 595967d

function setWorkspaceTagEnabled(policyID: string, tagsToUpdate: Record<string, {name: string; enabled: boolean}>, tagListIndex: number) {

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

We should handle it the same way we do with categories.

App/src/libs/actions/Policy/Category.ts

Lines 148 to 256 in 595967d

	function setWorkspaceCategoryEnabled(policyID: string, categoriesToUpdate: Record<string, {name: string; enabled: boolean}>) {
	const policyCategories = allPolicyCategories?.[`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`] ?? {};
	const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`];
	const optimisticPolicyCategoriesData = {
	...Object.keys(categoriesToUpdate).reduce<PolicyCategories>((acc, key) => {
	acc[key] = {
	...policyCategories[key],
	...categoriesToUpdate[key],
	errors: null,
	pendingFields: {
	enabled: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
	},
	pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
	};
	return acc;
	}, {}),
	};
	const shouldDisableRequiresCategory = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});
	const onyxData: OnyxData = {
	optimisticData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`,
	value: optimisticPolicyCategoriesData,
	},
	],
	successData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`,
	value: {
	...Object.keys(categoriesToUpdate).reduce<PolicyCategories>((acc, key) => {
	acc[key] = {
	...policyCategories[key],
	...categoriesToUpdate[key],
	errors: null,
	pendingFields: {
	enabled: null,
	},
	pendingAction: null,
	};
	return acc;
	}, {}),
	},
	},
	],
	failureData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`,
	value: {
	...Object.keys(categoriesToUpdate).reduce<PolicyCategories>((acc, key) => {
	acc[key] = {
	...policyCategories[key],
	...categoriesToUpdate[key],
	errors: ErrorUtils.getMicroSecondOnyxError('workspace.categories.updateFailureMessage'),
	pendingFields: {
	enabled: null,
	},
	pendingAction: null,
	};
	return acc;
	}, {}),
	},
	},
	],
	};
	if (shouldDisableRequiresCategory) {
	onyxData.optimisticData?.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
	value: {
	requiresCategory: false,
	pendingFields: {
	requiresCategory: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
	},
	},
	});
	onyxData.successData?.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
	value: {
	pendingFields: {
	requiresCategory: null,
	},
	},
	});
	onyxData.failureData?.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
	value: {
	requiresCategory: policy?.requiresCategory,
	pendingFields: {
	requiresCategory: null,
	},
	},
	});
	}
	const parameters = {
	policyID,
	categories: JSON.stringify(Object.keys(categoriesToUpdate).map((key) => categoriesToUpdate[key])),
	};
	API.write(WRITE_COMMANDS.SET_WORKSPACE_CATEGORIES_ENABLED, parameters, onyxData);
	}

Pseudo code

function setWorkspaceTagEnabled(policyID: string, tagsToUpdate: Record<string, {name: string; enabled: boolean}>, tagListIndex: number) {
    const policyTag = PolicyUtils.getTagLists(allPolicyTags?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`] ?? {})?.[tagListIndex] ?? {};

    const optimisticPolicyTagsData = {
        ...Object.keys(tagsToUpdate).reduce<PolicyTags>((acc, key) => {
            acc[key] = {
                ...policyTag.tags[key],
                ...tagsToUpdate[key],
                errors: null,
                pendingFields: {
                    enabled: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
                },
                pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
            };

            return acc;
        }, {}),
    };
    const shouldDisableRequiresTag = !OptionsListUtils.hasEnabledOptions({...policyTag.tags, ...optimisticPolicyTagsData});

    const onyxData: OnyxData = {
        optimisticData: [
            {
                onyxMethod: Onyx.METHOD.MERGE,
                key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`,
                value: {
                    [policyTag.name]: {
                        ...(shouldDisableRequiresTag ? {required: false, pendingFields: {required: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE}, errorFields: {required: null}} : {}),
                        tags: optimisticPolicyTagsData,
                    },
                },
            },
        ],
        successData: [
            {
                onyxMethod: Onyx.METHOD.MERGE,
                key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`,
                value: {
                    [policyTag.name]: {
                        tags: {
                            ...(shouldDisableRequiresTag ? {pendingFields: {required: null}} : {}),
                            ...Object.keys(tagsToUpdate).reduce<PolicyTags>((acc, key) => {
                                acc[key] = {
                                    ...policyTag.tags[key],
                                    ...tagsToUpdate[key],
                                    errors: null,
                                    pendingFields: {
                                        enabled: null,
                                    },
                                    pendingAction: null,
                                };

                                return acc;
                            }, {}),
                        },
                    },
                },
            },
        ],
        failureData: [
            {
                onyxMethod: Onyx.METHOD.MERGE,
                key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`,
                value: {
                    [policyTag.name]: {
                        tags: {
                            ...(shouldDisableRequiresTag ? {pendingFields: {required: null}, required: policyTag.required} : {}),
                            ...Object.keys(tagsToUpdate).reduce<PolicyTags>((acc, key) => {
                                acc[key] = {
                                    ...policyTag.tags[key],
                                    ...tagsToUpdate[key],
                                    errors: ErrorUtils.getMicroSecondOnyxError('workspace.tags.genericFailureMessage'),
                                    pendingFields: {
                                        enabled: null,
                                    },
                                    pendingAction: null,
                                };

                                return acc;
                            }, {}),
                        },
                    },
                },
            },
        ],
    };

    const parameters: SetPolicyTagsEnabled = {
        policyID,
        tags: JSON.stringify(Object.keys(tagsToUpdate).map((key) => tagsToUpdate[key])),
        tagListIndex,
    };

    API.write(WRITE_COMMANDS.SET_POLICY_TAGS_ENABLED, parameters, onyxData);
}

What alternative solutions did you explore? (Optional)

Result

Monosnap.screencast.2024-06-13.23-51-46.mp4

[akinwale]

@Krishna2323's proposal works here since it follows the same method of an already existing implementation for categories.

🎀👀🎀 C+ reviewed.

[melvin-bot]

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

[melvin-bot]

📣 @akinwale 🎉 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]

📣 @Krishna2323 🎉 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 📖

[Krishna2323]

@akinwale, PR ready for review.

[melvin-bot]

This issue has not been updated in over 15 days. @cead22, @akinwale, @Krishna2323 eroding to Monthly issue.

P.S. Is everyone reading this sure this is really a near-term priority? Be brave: if you disagree, go ahead and close it out. If someone disagrees, they'll reopen it, and if they don't: one less thing to do!

[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.7-8 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: QBO - Required remains enabled when all tags are disabled #43813

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

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

• @akinwale requires payment automatic offer (Reviewer)
• @Krishna2323 requires payment automatic offer (Contributor)

[melvin-bot]

Issue is ready for payment but no BZ is assigned. @dylanexpensify you are the lucky winner! Please verify the payment summary looks correct and complete the checklist. Thanks!

[melvin-bot]

@cead22, @akinwale, @dylanexpensify, @Krishna2323 Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[mallenexpensify]

Contributor: @Krishna2323 paid $250 via Upwork
Contributor+: @akinwale paid $250 via Upwork.

@akinwale plz complete the BZ checklist below?

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@] The PR that introduced the bug has been identified. Link to the PR:
• [@] 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:
• [@] 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:
• [@] Determine if we should create a regression test for this bug.
• [@] 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.
• [@bz] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[akinwale]

• [@] The PR that introduced the bug has been identified. Link to the PR:
• [@] 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:
• [@] 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:

Not a regression. The specific functionality was not implemented.

• [@] Determine if we should create a regression test for this bug.
• [@] 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 Steps
Precondition: Account is connected to QBO

1. Launch Expensify.
2. Navigate to the settings for the workspace connected to QBO.
3. Navigate to Tags.
4. Toggle the Required switch.
5. Select all tags.
6. Disable all tags.
7. Verify that the "Required" switch is disabled and locked when all tags are disabled.

Do we agree 👍 or 👎?

[mallenexpensify]

Thanks @akinwale , test case created!
https://github.com/Expensify/Expensify/issues/416507