Add a switch for requiring tags on the multi level tags RHP #42972

hayata-suenaga · 2024-06-02T19:00:36Z

Details

This PR adds a switch component on the RHP that appears when the user clicks a multi-level tag (only available when tags are imported from an accounting connection).

With this switch, the admin can decide whether to require tagging on each category (classes or customers/projects).

Fixed Issues

$ #41374
PROPOSAL: N/A

Tests / QA Steps

Create a workspace, enable the accounting feature on the More Features page, and connect to QBO on the Accounting page.
Go to the tags page. You should see Classes and Customers/Projects imported.
Click Classes. Confirm that you see the Switcher component with the text "Members must tag all expenses"
Confirm you can toggle on / off this option
Log out of the app. Log back in. Confirm that the on/off selection is still preserved.
Disabled all the tags under Classes by bulk selecting and clicking "Disable tags".
Check that the Switch component is locked off.

Offline tests

N/A

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-06-02.at.2.30.12.PM.mov

MacOS: Desktop

melvin-bot · 2024-06-02T19:40:34Z

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

s77rt · 2024-06-02T20:07:51Z

The required label and location is not aligned with the design from #41279

326640135-fcf9ec92-e7c6-4ffc-877d-1af719e64dab (1)

src/libs/actions/Policy/Tag.ts

src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

hayata-suenaga · 2024-06-02T22:00:20Z

Update: For updating the requires tags in the account level, we have to use another API.

hayata-suenaga · 2024-06-02T22:23:52Z

@s77rt, so the API for requiring tags in the context of multi level tags is different from requiring tagging for all tags in the workspace. Add the necessary code to call this different API command

src/libs/actions/Policy/Tag.ts

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

s77rt · 2024-06-06T17:17:20Z

@hayata-suenaga Still need one more ts cbeck

hayata-suenaga · 2024-06-06T19:43:21Z

@s77rt, this is ready for another review 🙇

s77rt

Hopefully last comment

src/pages/workspace/tags/WorkspaceTagsPage.tsx

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

s77rt · 2024-06-07T16:17:42Z

@hayata-suenaga lint please

melvin-bot · 2024-06-07T16:43:07Z

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

aldo-expensify · 2024-06-08T00:06:39Z

src/libs/actions/Policy/Tag.ts

@@ -359,10 +360,21 @@ function clearPolicyTagErrors(policyID: string, tagName: string) {
 });
 }

+function clearPolicyTagListError(policyID: string, tagListIndex: number, errorField: string) {
+ const policyTag = PolicyUtils.getTagLists(allPolicyTags?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`] ?? {})?.[tagListIndex] ?? {};
+


Suggested change

if (!policyTag.name) {

return;

}

The line above makes it looks like policyTag could end up being {}, what happens then if policyTag.name is undefined? I think we should avoid calling Onyx.merge in such case.

if policyTag is not expected to end up as {}, then I think we shouldn't have ?? {}.

src/libs/actions/Policy/Tag.ts

Gonals · 2024-06-12T13:58:49Z

Seems like we have some lint issues

…res-tags-button

aldo-expensify · 2024-06-12T20:10:07Z

@Gonals I pushed main and the styles seems to not be complaining now.

OSBotify · 2024-06-13T08:48:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

hayata-suenaga · 2024-06-14T05:42:52Z

Thank you for merging, Aldo! 🙇

OSBotify · 2024-06-14T23:03:22Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.83-3 🚀

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

jayeshmangwani · 2024-06-27T13:15:59Z

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

@@ -234,6 +234,18 @@ function WorkspaceViewTagsPage({route}: WorkspaceViewTagsProps) {
 cancelText={translate('common.cancel')}
 danger
 />
+ <View style={[styles.pv4, styles.ph5]}>
+ <ToggleSettingOptionRow


Coming from this issue #43758, we should have hide the required option for dependent tags, because dependent tag lists cannot be required. More context #43758 (comment) #43758 (comment)

feat: pass a new parameter to the requires tags api

59c508b

hayata-suenaga self-assigned this Jun 2, 2024

Hayata Suenaga added 3 commits June 2, 2024 14:08

chore: add new constant

6a2c8ee

feat: add the toggle button

336c036

chore: disable the switch if all tags are not active

5bcd53b

hayata-suenaga requested a review from s77rt June 2, 2024 19:39

hayata-suenaga marked this pull request as ready for review June 2, 2024 19:40

hayata-suenaga requested a review from a team as a code owner June 2, 2024 19:40

melvin-bot bot removed the request for review from a team June 2, 2024 19:40

hayata-suenaga mentioned this pull request Jun 2, 2024

feat: add switch toggle #42952

Closed

50 tasks

fix: remove unnecessary import

95c360b

hayata-suenaga mentioned this pull request Jun 2, 2024

[Awaiting Payment 25th June] [QBO] Implement the Required toggle in the RHP with multiLevel tags. #41374

Closed

s77rt suggested changes Jun 2, 2024

View reviewed changes

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx Outdated Show resolved Hide resolved

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx Outdated Show resolved Hide resolved

Hayata Suenaga added 4 commits June 2, 2024 16:15

fix: UI copy and error message

75b21eb

fix: component position

39f7fac

chore: remove unused error util

6a03be3

fix: swap the API to call

e1246a8

Hayata Suenaga added 6 commits June 2, 2024 17:06

fix: add back the command to make all tags required

da8ca41

chore: add back the API param type

ec97f63

chore: add back the API command

18e3d27

chore: export the parameter type

ffd3507

fix: add back the old API call

21c49fe

fix: remove extra parameters

b477d14

hayata-suenaga requested a review from s77rt June 2, 2024 22:22

s77rt reviewed Jun 2, 2024

View reviewed changes

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

fix: remove null

3a450df

Hayata Suenaga and others added 2 commits June 6, 2024 08:06

fix: use orderWeight from route params

70f7c6b

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

chore: pass missing argument to the clear error function

1ca0837

Hayata Suenaga added 2 commits June 6, 2024 13:12

Merge branch 'main' into hayata-add-requires-tags-button

327cc7d

fix: pass the missing argument to the function to clear the error

83bca4b

hayata-suenaga requested a review from s77rt June 6, 2024 19:43

s77rt suggested changes Jun 6, 2024

View reviewed changes

src/pages/workspace/tags/WorkspaceTagsPage.tsx Outdated Show resolved Hide resolved

Hayata Suenaga and others added 2 commits June 7, 2024 10:48

Merge branch 'main' into hayata-add-requires-tags-button

d6f5800

only clear policy tag error when the items renders are policy tags

cdd4365

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>

fix: lint issue

050471f

s77rt approved these changes Jun 7, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals June 7, 2024 16:43

aldo-expensify reviewed Jun 8, 2024

View reviewed changes

return of policy tag name is undefined

bef9b95

Merge branch 'main' of github.com:Expensify/App into hayata-add-requi…

9b97a25

…res-tags-button

Gonals approved these changes Jun 13, 2024

View reviewed changes

Gonals merged commit e9799d9 into main Jun 13, 2024
15 checks passed

Gonals deleted the hayata-add-requires-tags-button branch June 13, 2024 08:40

github-actions bot mentioned this pull request Jun 13, 2024

Deploy Checklist: New Expensify 2024-06-13 #43655

Closed

64 tasks

lanitochka17 mentioned this pull request Jun 13, 2024

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

Closed

6 tasks

jayeshmangwani reviewed Jun 27, 2024

View reviewed changes

jayeshmangwani mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-06-28] Multi tags - Error shows up when disabling "Required" toggle #43758

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a switch for requiring tags on the multi level tags RHP #42972

Add a switch for requiring tags on the multi level tags RHP #42972

hayata-suenaga commented Jun 2, 2024 •

edited

Loading

melvin-bot bot commented Jun 2, 2024

s77rt commented Jun 2, 2024

hayata-suenaga commented Jun 2, 2024

hayata-suenaga commented Jun 2, 2024

s77rt commented Jun 6, 2024

hayata-suenaga commented Jun 6, 2024

s77rt left a comment

s77rt commented Jun 7, 2024

melvin-bot bot commented Jun 7, 2024

aldo-expensify Jun 8, 2024

Gonals commented Jun 12, 2024

aldo-expensify commented Jun 12, 2024

OSBotify commented Jun 13, 2024

hayata-suenaga commented Jun 14, 2024

OSBotify commented Jun 14, 2024

jayeshmangwani Jun 27, 2024

+ if (!policyTag.name) {
+ return;
+ }

Add a switch for requiring tags on the multi level tags RHP #42972

Add a switch for requiring tags on the multi level tags RHP #42972

Conversation

hayata-suenaga commented Jun 2, 2024 • edited Loading

Details

Fixed Issues

Tests / QA Steps

Offline tests

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 2, 2024

s77rt commented Jun 2, 2024

hayata-suenaga commented Jun 2, 2024

hayata-suenaga commented Jun 2, 2024

s77rt commented Jun 6, 2024

hayata-suenaga commented Jun 6, 2024

s77rt left a comment

Choose a reason for hiding this comment

s77rt commented Jun 7, 2024

melvin-bot bot commented Jun 7, 2024

aldo-expensify Jun 8, 2024

Choose a reason for hiding this comment

Gonals commented Jun 12, 2024

aldo-expensify commented Jun 12, 2024

OSBotify commented Jun 13, 2024

hayata-suenaga commented Jun 14, 2024

OSBotify commented Jun 14, 2024

jayeshmangwani Jun 27, 2024

Choose a reason for hiding this comment

hayata-suenaga commented Jun 2, 2024 •

edited

Loading