Disable Required Toggle When No Subtags Are Enabled #48381

Shahidullah-Muffakir · 2024-08-31T23:45:57Z

Details

When all subtags are disabled, the "Required" toggle should automatically turn off. However, it currently remains toggled on.
A check is added to determine if any subtags are enabled. If none are, the setPolicyTagsRequired function will be called to set the "Required" toggle to off.

Fixed Issues

$ #47818
PROPOSAL:#47818 (comment)

Tests

Go to Workspace Settings > Tags.
Click on any main tag to open its settings.
Enable the "Required" switch by toggling it on.
Select all the subtags associated with the main tag.
Disable all the selected subtags.
Verify that the "Required" switch becomes locked and is automatically toggled off.
Dismiss the Right-Hand Panel (RHP) by closing it.
Reopen the same main tag to verify that the "Required" switch remains off and locked, reflecting the disabled state of the subtags.

Verify that no errors appear in the JS console

Offline tests

Go to Workspace Settings > Tags.
Click on any main tag to open its settings.
Enable the "Required" switch by toggling it on.
Select all the subtags associated with the main tag.
Disable all the selected subtags.
Verify that the "Required" switch becomes locked and is automatically toggled off.
Dismiss the Right-Hand Panel (RHP) by closing it.
Reopen the same main tag to verify that the "Required" switch remains off and locked, reflecting the disabled state of the subtags.

Verify that no errors appear in the JS console

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

androidNative.mov

Android: mWeb Chrome

androidWeb.mov

iOS: Native

iphoneNative.mp4

iOS: mWeb Safari

iphoneWeb.mp4

MacOS: Chrome / Safari

macosSafari.mov

MacOS: Desktop

desktop.mov

…gs are disabled

melvin-bot · 2024-08-31T23:46:02Z

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

ikevin127 · 2024-09-03T19:20:27Z

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

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


Suggested change

if (!Object.values(currentPolicyTag?.tags ?? {}).some((tag) => tag.enabled)) {

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

}

if (!Object.values(currentPolicyTag?.tags ?? {}).some((tag) => tag.enabled)) {

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

}

⚠️ @Shahidullah-Muffakir Next time after you are done with the changes, please run npm run prettier in order to prettify the code, otherwise the prettier related checks for the PR will fail.

In this case the ; (semicolon) was missing at the end of the setPolicyTagsRequired function call.
Additionally, I added some spacing on top and bottom of the if for better readability.

Got it, I will add the semicolon and adjust the spacing in this PR. I'll also make sure to run npm run prettier in my upcoming PRs. Thank you.

ikevin127 · 2024-09-03T19:42:14Z

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

@@ -231,7 +231,9 @@ function WorkspaceViewTagsPage({route}: WorkspaceViewTagsProps) {
            />
        );
    };
-
+    if (!Object.values(currentPolicyTag?.tags ?? {}).some((tag) => tag.enabled)) {
+        Tag.setPolicyTagsRequired(policyID, false, route.params.orderWeight)


Caution
There's currently an issue with the implementation which would block this from being merged, basically there's an infinite loop of the setPolicyTagsRequired call (see video below) which needs to be fixed such that:

The call would only be made once when all subtags are Disabled.

The call would not be made again when the page is refreshed and the tags RHP (right hand panel) is re-opened (like it does in the video towards the end).

call-loop-issue.mov

cc @Shahidullah-Muffakir I will be able to pick-up the review and complete the checklist once the issue is fixed and the fix works as expected.

Got it. We can update the condition to:

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

This will ensure the call is only made when needed and only once. I’ve tested it, and it works as expected. Let me know what you think. Thanks!

@ikevin127 I pushed the changes, Please take a look when you can. Thanks!

Thanks for addressing the issues, I'll move forward with the review!

…nto fix/47818

…App into fix/47818

ikevin127

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.webm

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

OSBotify · 2024-09-04T19:48:10Z

✋ 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-09-05T19:40:56Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.30-0 🚀

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

ikevin127 · 2024-09-19T19:30:11Z

We determined that this PR didn't cause issue #48683 as in regression but moreso revealed some incomplete logic, therefore this PR was not treated as a regression coming from the other issue's PR - more context in #47818 (comment).

ensure the Required toggle is turned off automatically when all subta…

8c136f1

…gs are disabled

Shahidullah-Muffakir requested a review from a team as a code owner August 31, 2024 23:45

melvin-bot bot requested a review from ikevin127 August 31, 2024 23:46

melvin-bot bot removed the request for review from a team August 31, 2024 23:46

ikevin127 suggested changes Sep 3, 2024

View reviewed changes

Shahidullah-Muffakir and others added 5 commits September 4, 2024 01:56

Merge branch 'main' of github.com:Shahidullah-Muffakir/ExpensifyApp i…

c76bef7

…nto fix/47818

Merge branch 'Expensify:main' into fix/47818

ade16d8

Merge branch 'Expensify:main' into fix/47818

0656872

Updated condition to call setPolicyTagsRequired only when necessary.

10af826

Merge branch 'fix/47818' of github.com:Shahidullah-Muffakir/Expensify…

ec5e76e

…App into fix/47818

ikevin127 approved these changes Sep 3, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath September 3, 2024 23:24

puneetlath approved these changes Sep 4, 2024

View reviewed changes

puneetlath merged commit d67d3d0 into Expensify:main Sep 4, 2024
17 of 18 checks passed

github-actions bot mentioned this pull request Sep 5, 2024

Deploy Checklist: New Expensify 2024-09-05 #48664

Closed

69 tasks

izarutskaya mentioned this pull request Sep 6, 2024

[Awaiting Payment] [$250] Multi tags - Main tag shows "Required" status when all the subtags are disabled #48683

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Disable Required Toggle When No Subtags Are Enabled #48381

Disable Required Toggle When No Subtags Are Enabled #48381

Shahidullah-Muffakir commented Aug 31, 2024

melvin-bot bot commented Aug 31, 2024

ikevin127 Sep 3, 2024

Shahidullah-Muffakir Sep 3, 2024

ikevin127 Sep 3, 2024

Shahidullah-Muffakir Sep 3, 2024

Shahidullah-Muffakir Sep 3, 2024

ikevin127 Sep 3, 2024

ikevin127 left a comment

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

ikevin127 commented Sep 19, 2024

Disable Required Toggle When No Subtags Are Enabled #48381

Disable Required Toggle When No Subtags Are Enabled #48381

Conversation

Shahidullah-Muffakir commented Aug 31, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 31, 2024

ikevin127 Sep 3, 2024

Choose a reason for hiding this comment

Shahidullah-Muffakir Sep 3, 2024

Choose a reason for hiding this comment

ikevin127 Sep 3, 2024

Choose a reason for hiding this comment

Shahidullah-Muffakir Sep 3, 2024

Choose a reason for hiding this comment

Shahidullah-Muffakir Sep 3, 2024

Choose a reason for hiding this comment

ikevin127 Sep 3, 2024

Choose a reason for hiding this comment

ikevin127 left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

ikevin127 commented Sep 19, 2024