Add a switch to toggle on/off "require tags" on `WorkspaceViewTagsPage` by hayata-suenaga · Pull Request #42328 · Expensify/App

hayata-suenaga · 2024-05-17T03:08:54Z

Details

Adds the new Switch component to enable/disable "Require tags" on the parent tag level when there are multi-level tags.

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.
Do the same thing for Customers/Projects

Offline tests

Do the same test as the above. You should do Steps 1 and 2 while online. and the rest offline.

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.
I verified that similar component doesn't exist in the codebase
I verified that all props are defined accurately and each prop has a /** comment above it */
I verified that each file is named correctly
I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
I verified that the only data being stored in component state is data necessary for rendering and nothing else
In component if we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
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)
I verified that component 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)
I verified that all JSX used for rendering exists in the render method
I verified that each 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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-17T03:08:59Z

@s77rt 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-05-17T03:11:59Z

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

+                <View style={[styles.pv4, styles.ph5]}>
+                    <View style={[styles.flexRow, styles.mb5, styles.mr2, styles.alignItemsCenter, styles.justifyContentBetween]}>
+                        <Text style={[styles.textNormal]}>{translate('workspace.tags.requiresTag')}</Text>
+                        <Switch
+                            isOn={Boolean(policyTagList?.required)}
+                            accessibilityLabel={translate('workspace.tags.requiresTag')}
+                            onToggle={(on) => Policy.setWorkspaceTagListRequired(policyID, route.params.orderWeight ?? 0, on)}
+                        />
+                    </View>
+                </View>


Use ToggleSettingOptionRow and pass errors and pending action

s77rt · 2024-05-17T03:14:26Z

src/libs/API/parameters/SetPolicyTagsRequired.ts

+     * When the tags are imported as multi level tags, the index of the top
+     * most tag list item
+     */
+    tagListIndex?: number;


Not optional

s77rt · 2024-05-17T15:39:42Z

src/libs/API/parameters/SetPolicyTagsRequired.ts

+    /**
+     * When the tags are imported as multi level tags, the index of the top
+     * most tag list item
+     */


Remove comment, not needed

src/libs/actions/Policy.ts

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx

hayata-suenaga · 2024-05-20T21:07:22Z

thanks for the quick review. I'm working on this right now. I'll let you know once the PR is ready for review 😄

hayata-suenaga · 2024-05-20T22:41:37Z

PR not ready yet for review 🙇

hayata-suenaga · 2024-05-22T19:10:59Z

I'm not sure why TypeScript checks are failing here. The failed code is not a part changed by this PR.

I merged the latest main but it's still failing. 🤔 @s77rt do you have any idea?

s77rt · 2024-05-22T19:29:24Z

@hayata-suenaga I don't see the commit where you merged main or qbo-freeze-branch, can you double check

hayata-suenaga · 2024-05-22T20:34:40Z

When I tried to merge the main branch this morning, there was no update on the main branch (we have been having merge freeze so it makes sense). Now I see some changes. I'll merge and see if that is going to fix the issue.

…-level

src/libs/API/types.ts

…-level

…gs-per-parent-level

…-level

s77rt · 2024-05-30T13:13:50Z

@hayata-suenaga You merged both main and qbo-freeze-branch into hayata-add-switch-to-require-tags-per-parent-level thus targeting any of these branches will have other unwanted commits. I think want you are looking for is to revert the qbo-freeze-branch merge i.e. a367437

hayata-suenaga · 2024-05-30T20:06:09Z

@hayata-suenaga You merged both main and qbo-freeze-branch into hayata-add-switch-to-require-tags-per-parent-level thus targeting any of these branches will have other unwanted commits. I think want you are looking for is to revert the qbo-freeze-branch merge i.e. a367437

yep that is what I was working on last night but was having an issue with reverting the merge. I'll try this again now.

…r-parent-level" This reverts commit 6e29856, reversing changes made to a367437.

…quire-tags-per-parent-level" This reverts commit a367437, reversing changes made to afdda1a.

…r-parent-level" This reverts commit afdda1a, reversing changes made to 346f796.

hayata-suenaga · 2024-05-31T21:15:55Z

keep working on this branch/PR instead -> #42952

hayata-suenaga · 2024-06-02T21:20:39Z

closing this PR

Hayata Suenaga added 4 commits May 16, 2024 19:40

feat: add new write command

1a06d5f

feat: define parameters for the new API command

34ddf7d

feat: create a new action

a05a84d

feat: add new switch button

d1fb612

hayata-suenaga self-assigned this May 17, 2024

hayata-suenaga requested a review from a team as a code owner May 17, 2024 03:08

melvin-bot bot requested review from s77rt and removed request for a team May 17, 2024 03:08

Hayata Suenaga added 2 commits May 16, 2024 20:09

fix: update the word in UI copy

62664ef

fix: update spanish translation

9fa5d55

hayata-suenaga changed the title ~~Hayata add switch to require tags per parent level~~ Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage May 17, 2024

s77rt suggested changes May 17, 2024

View reviewed changes

hayata-suenaga changed the title ~~Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage~~ [HOLD Web-E PR]Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage May 17, 2024

hayata-suenaga changed the title ~~[HOLD Web-E PR]Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage~~ [HOLD Web-E PR] Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage May 17, 2024

hayata-suenaga changed the title ~~[HOLD Web-E PR] Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage~~ [HOLD Web-E PR #42066] Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage May 17, 2024

Hayata Suenaga added 2 commits May 16, 2024 20:26

fix: make param not optional

bf1990b

chore: use OptionsRow component

42ef253

s77rt reviewed May 17, 2024

View reviewed changes

chore: draft

57146b5

Hayata Suenaga added 5 commits May 20, 2024 17:20

feat: add a new const

8215444

chore: remove redundant tag component & supply errors

07ee7e8

fix: remove unnecessary import

4d20d69

chore: remove redundant field value update

a49f175

doc: remove unnecessary comments

8639607

hayata-suenaga changed the base branch from main to qbo-freeze-branch May 21, 2024 00:27

Merge branch 'main' into hayata-add-switch-to-require-tags-per-parent…

03caee3

…-level

s77rt reviewed May 22, 2024

View reviewed changes

src/libs/API/types.ts Show resolved Hide resolved

Hayata Suenaga added 2 commits May 22, 2024 16:55

fix: type errors

346f796

Merge branch 'main' into hayata-add-switch-to-require-tags-per-parent…

afdda1a

…-level

hayata-suenaga requested a review from a team as a code owner May 23, 2024 18:27

Merge branch 'qbo-freeze-branch' into hayata-add-switch-to-require-ta…

a367437

…gs-per-parent-level

hayata-suenaga changed the title ~~[HOLD Web-E PR #42066] Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage~~ Add a switch to toggle on/off "require tags" on WorkspaceViewTagsPage May 29, 2024

Merge branch 'main' into hayata-add-switch-to-require-tags-per-parent…

6e29856

…-level

hayata-suenaga changed the base branch from qbo-freeze-branch to main May 30, 2024 05:22

trjExpensify mentioned this pull request May 31, 2024

QBO freeze branch #42543

Merged

49 tasks

Hayata Suenaga added 2 commits May 31, 2024 10:07

Revert "Merge branch 'main' into hayata-add-switch-to-require-tags-pe…

6cb48b8

…r-parent-level" This reverts commit 6e29856, reversing changes made to a367437.

Revert "Merge branch 'qbo-freeze-branch' into hayata-add-switch-to-re…

35992e8

…quire-tags-per-parent-level" This reverts commit a367437, reversing changes made to afdda1a.

hayata-suenaga force-pushed the hayata-add-switch-to-require-tags-per-parent-level branch from bfc9344 to 35992e8 Compare May 31, 2024 20:38

Revert "Merge branch 'main' into hayata-add-switch-to-require-tags-pe…

39abfab

…r-parent-level" This reverts commit afdda1a, reversing changes made to 346f796.

hayata-suenaga closed this Jun 2, 2024

Conversation

hayata-suenaga commented May 17, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests / QA Steps

Offline tests

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 17, 2024

Uh oh!

s77rt May 17, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt May 17, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt May 17, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hayata-suenaga commented May 20, 2024

Uh oh!

hayata-suenaga commented May 20, 2024

Uh oh!

hayata-suenaga commented May 22, 2024

Uh oh!

s77rt commented May 22, 2024

Uh oh!

hayata-suenaga commented May 22, 2024

Uh oh!

Uh oh!

s77rt commented May 30, 2024

Uh oh!

hayata-suenaga commented May 30, 2024

Uh oh!

hayata-suenaga commented May 31, 2024

Uh oh!

hayata-suenaga commented Jun 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hayata-suenaga commented May 17, 2024 •

edited by github-actions bot

Loading