Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 45 commits into from
Jun 13, 2024

Conversation

hayata-suenaga
Copy link
Contributor

@hayata-suenaga hayata-suenaga commented Jun 2, 2024

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

  1. Create a workspace, enable the accounting feature on the More Features page, and connect to QBO on the Accounting page.
  2. Go to the tags page. You should see Classes and Customers/Projects imported.
  3. Click Classes. Confirm that you see the Switcher component with the text "Members must tag all expenses"
  4. Confirm you can toggle on / off this option
  5. Log out of the app. Log back in. Confirm that the on/off selection is still preserved.
  6. Disabled all the tags under Classes by bulk selecting and clicking "Disable tags".
  7. 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

@hayata-suenaga hayata-suenaga self-assigned this Jun 2, 2024
@hayata-suenaga hayata-suenaga requested a review from s77rt June 2, 2024 19:39
@hayata-suenaga hayata-suenaga marked this pull request as ready for review June 2, 2024 19:40
@hayata-suenaga hayata-suenaga requested a review from a team as a code owner June 2, 2024 19:40
@melvin-bot melvin-bot bot removed the request for review from a team June 2, 2024 19:40
Copy link

melvin-bot bot commented Jun 2, 2024

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

@hayata-suenaga hayata-suenaga mentioned this pull request Jun 2, 2024
50 tasks
@s77rt
Copy link
Contributor

s77rt commented Jun 2, 2024

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

326640135-fcf9ec92-e7c6-4ffc-877d-1af719e64dab (1) Screenshot 2024-06-02 at 9 06 33 PM

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
Copy link
Contributor Author

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

@hayata-suenaga hayata-suenaga requested a review from s77rt June 2, 2024 22:22
@hayata-suenaga
Copy link
Contributor Author

@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 Outdated Show resolved Hide resolved
src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved
Hayata Suenaga and others added 2 commits June 6, 2024 08:06
Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
@s77rt
Copy link
Contributor

s77rt commented Jun 6, 2024

@hayata-suenaga Still need one more ts cbeck

@hayata-suenaga hayata-suenaga requested a review from s77rt June 6, 2024 19:43
@hayata-suenaga
Copy link
Contributor Author

@s77rt, this is ready for another review 🙇

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully last comment

src/pages/workspace/tags/WorkspaceTagsPage.tsx Outdated Show resolved Hide resolved
Hayata Suenaga and others added 2 commits June 7, 2024 10:48
@s77rt
Copy link
Contributor

s77rt commented Jun 7, 2024

@hayata-suenaga lint please

Copy link

melvin-bot bot commented Jun 7, 2024

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

@melvin-bot melvin-bot bot requested a review from Gonals June 7, 2024 16:43
@@ -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] ?? {};

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Show resolved Hide resolved
@Gonals
Copy link
Contributor

Gonals commented Jun 12, 2024

Seems like we have some lint issues

@aldo-expensify
Copy link
Contributor

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

@Gonals Gonals merged commit e9799d9 into main Jun 13, 2024
15 checks passed
@Gonals Gonals deleted the hayata-add-requires-tags-button branch June 13, 2024 08:40
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor Author

Thank you for merging, Aldo! 🙇

@OSBotify
Copy link
Contributor

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

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants