[HOLD for Payment 2024-09-17] [$250] Multi tags - "Required" switch is enabled after disabling all subtags & reopening subtag list

[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: v9.0.23-0
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail: Exp https://expensify.testrail.io/index.php?/tests/view/4880485
Email or phone of affected tester (no customers): applausetester+kh050806@applause.expensifail.com
Issue reported by: Applause Internal Team

Action Performed:

Precondition:

• Workspace has independant tags set up on OD.

1. Go to staging.new.expensify.com
2. Go to workspace settings > Tags.
3. Click on any main tag.
4. Enable "Required" switch.
5. Select all the subtags > Disable.
6. Disable all the subtags.
7. Note that "Required" switch is locked and disabled.
8. Dismiss the RHP.
9. Click on the same main tag.

Expected Result:

"Required" switch will remain locked and disabled.

Actual Result:

Required" switch is enabled after disabling all subtags & reopening subtag list.

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Bug6578591_1724267622859.20240822_030758.mp4

Bug6578591_1724267622842!Independent.-.Multi.Level.tags.csv

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0135a412ea484831b7
• Upwork Job ID: 1826359908145270693
• Last Price Increase: 2024-08-28
• Automatic offers:
• ikevin127 | Reviewer | 103741874

Issue Owner

Current Issue Owner: @ikevin127

[melvin-bot]

Triggered auto assignment to @puneetlath (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-collect - Release 1

[IuliiaHerets]

@puneetlath 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/~0135a412ea484831b7

[melvin-bot]

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

[Krishna2323]

Edited by proposal-police: This proposal was edited at 2024-08-21 21:02:12 UTC.

Proposal

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

Multi tags - "Required" switch is enabled after disabling all subtags & reopening subtag list

What is the root cause of that problem?

The required value is only toggled in the optimistic data, when the backend returns the response the required value is again turned to required.
https://github.com/Expensify/App/blob/12037eef23dfb54b73d05ea28bd0b7334a7ca153/src/libs/actions/Policy/Tag.ts#L218C29-L218C53

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

Line 230 in 12037ee

...(shouldDisableRequiredTag ? {pendingFields: {required: null}} : {}),

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

Line 257 in 12037ee

...(shouldDisableRequiredTag ? {pendingFields: {required: null}, required: policyTag.required} : {}),

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

• We should pass the required value to the backend through parameters object.
• We might also need to update the backend to return the required value accordingly.
• The implementation will be the same as we do in setPolicyTagsRequired.
  

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

  Lines 764 to 769 in 12037ee

  	const parameters: SetPolicyTagsRequired = {
  	policyID,
  	tagListIndex,
  	requireTagList: requiresTag,
  	};

What alternative solutions did you explore? (Optional)


Result

[Shahidullah-Muffakir]

Proposal

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

When all subtags are disabled, the "Required" toggle should be toggled off. However, it is currently showing as toggled on, which creates confusion for users.

What is the root cause of that problem?

Currently, the "Required" state is only updated when the user manually toggles the Required Toggle. The setPolicyTagsRequired function is invoked solely when the user interacts with the toggle. Consequently, when all subtags are disabled, this function is not called, resulting in the "Required" toggle remaining on. To update the "Required" state correctly, we should call this function whenever getHeaderButtons is executed. If the number of enabled tags is zero, the required button should be turned off.

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

To address this issue, we can implement a check to see if any tags are enabled. If not, we should call the setPolicyTagsRequired function to turn off the required toggle. The suggested code change is as follows:

    if (!Object.values(currentPolicyTag?.tags ?? {}).some((tag) => tag.enabled)) {
        Tag.setPolicyTagsRequired(policyID, false, route.params.orderWeight)
    }

Here is the video afterMy Updates:
https://github.com/user-attachments/assets/ad799020-db34-4c13-9ac5-65581db542c5

[nkdengineer]

I think this is a BE bug since we can calculate required value via tagListIndex and tags data as we do in optimistic data.