Show child tags indented on the Tag list #32337

wlegolas · 2023-12-01T10:56:37Z

Details

Change método getTagsOptions to generate the Tag options indented if the tag is in the format parent: child
Add Unit Tests to validate the format of generated Tag options when there are tags with the format parent: child
Rename the method from getCategoryOptionTree to getIndentedOptionTree in the OptionsListUtils

Fixed Issues

$ #31753
PROPOSAL: #31753 (comment)

Tests

Pre-condition: The Workspace has Tags with the format parent: child

Log in to ND as an employee
Navigate to Workspace chat
Tap the "+" > Request money
Enter the amount
On the confirmation screen, tap the "Show more" button
Select "Tags"
Verify that tags with the format parent: child are showing indented

Verify that no errors appear in the JS console

Offline tests

Pre-condition: The Workspace has Tags with the format parent: child

Log in to ND as an employee
Navigate to Workspace chat
Turn off your network connection
Tap the "+" > Request money
Enter the amount
On the confirmation screen, tap the "Show more" button
Select "Tags"
Verify that tags with the format parent: child are showing indented

Verify that no errors appear in the JS console

QA Steps

Pre-condition: The Workspace has Tags with the format parent: child

Log in to ND as an employee
Navigate to Workspace chat
Tap the "+" > Request money
Enter the amount
On the confirmation screen, tap the "Show more" button
Select "Tags"
Verify that tags with the format parent: child are showing indented

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

test-evidence-Android-Native.mov

Android: mWeb Chrome

test-evidence-Android-mWeb-Chrome.mp4

iOS: Native

test-evidence-iOS-Native.mp4

iOS: mWeb Safari

test-evidence-iOS-mWeb-Safari.mp4

MacOS: Chrome / Safari

Chrome:

test-evidence-MacOS-Chrome.mp4

Safari

test-evidence-MacOS-Safari.mp4

MacOS: Desktop

test-evidence-MacOS-Desktop.mp4

MacOS: Chrome - Regression testing for Categories

regression-testing-for-categories.mov

melvin-bot · 2023-12-01T10:56:42Z

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

c3024 · 2023-12-01T13:45:41Z

Ensure that Tags with the format parent: child are showing indented

There is no checkbox for this. The checkbox is to verify that there are no errors in console in the template. Please do not modify the template significantly. I appreciate adding unit tests and the test for checking category indentation.

Please add this as another point as "Verify that tags with the format parent: child are showing indented" after "Select Tags" like

Select tags
Verify that tags with the format parent: child are showing indented

Sample guidelines for test steps are here

Checkbox in QA tests section is not ticked. Also that checkbox is for no errors in console.

c3024 · 2023-12-01T14:08:07Z

Please fetch main because this test is failing.

c3024 · 2023-12-01T15:08:30Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

c3024 · 2023-12-02T00:36:41Z

src/libs/OptionsListUtils.js

@@ -753,7 +753,7 @@ function sortTags(tags) {
 * @param {Boolean} [isOneLine] - a flag to determine if text should be one line


Please change the function description to a more generic description instead of one specifically for category to something like
"Builds the options for the tree hierarchy via indents"

Hi, @c3024 sorry I forgot to change this description.

Done: 3f5b02487

c3024 · 2023-12-02T02:25:42Z

@wlegolas please check the suggestions.

…ion tree when there is tags in the parent:cuild format

…the OptionsListUtils

wlegolas · 2023-12-03T09:56:30Z

Ensure that Tags with the format parent: child are showing indented

There is no checkbox for this. The checkbox is to verify that there are no errors in console in the template. Please do not modify the template significantly. I appreciate adding unit tests and the test for checking category indentation.

Please add this as another point as "Verify that tags with the format parent: child are showing indented" after "Select Tags" like

Select tags

Verify that tags with the format parent: child are showing indented

Sample guidelines for test steps are here

Checkbox in QA tests section is not ticked. Also that checkbox is for no errors in console.

Hi @c3024, thank you for your points, I changed the PR comment with your suggestions.

wlegolas · 2023-12-03T10:14:44Z

I appreciate adding unit tests and the test for checking category indentation.

Hi, @c3024 I didn't add tests for checking category indentation because the test below already validates the category indentation.

App/tests/unit/OptionsListUtilsTest.js

Lines 997 to 1010 in 1682be4

    
           const largeResult = OptionsListUtils.getFilteredOptions( 
        
               REPORTS, 
        
               PERSONAL_DETAILS, 
        
               [], 
        
               emptySearch, 
        
               selectedOptions, 
        
               [], 
        
               false, 
        
               false, 
        
               true, 
        
               largeCategoriesList, 
        
               recentlyUsedCategories, 
        
           ); 
        
           expect(largeResult.categoryOptions).toStrictEqual(largeResultList);

Have you seen another type of test that the test above doesn't cover?

…archy indentations

c3024 · 2023-12-03T10:43:36Z

Thanks @wlegolas for the changes.

didn't add tests for checking category indentation because the test below already validates the category indentation.

Sorry for being unclear. I meant the regression test video for categories added in the Screenshots/Videos section. Thank you for adding a video verifying category as well after the change.

c3024 · 2023-12-03T10:45:35Z

LGTM

wlegolas · 2023-12-04T10:41:49Z

Hi @neil-marcellini if you have any questions or suggestions, please let me know.

neil-marcellini

Looks great thank you!

OSBotify · 2023-12-04T18:34:48Z

✋ 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 · 2023-12-05T02:57:02Z

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-12-05T13:42:07Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.4.8-0 🚀

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

OSBotify · 2023-12-06T20:32:15Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

OSBotify · 2023-12-06T20:41:47Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

wlegolas requested a review from a team as a code owner December 1, 2023 10:56

melvin-bot bot requested review from c3024 and removed request for a team December 1, 2023 10:56

wlegolas mentioned this pull request Dec 1, 2023

[$500] Tag - Child tags are not indented on list #31753

Closed

6 tasks

c3024 reviewed Dec 2, 2023

View reviewed changes

wlegolas added 3 commits December 3, 2023 06:55

Change method getTagsOptions to retrieve the Tags structure as an opt…

6c9dbbf

…ion tree when there is tags in the parent:cuild format

Rename method from getCategoryOptionTree to getIndentedOptionTree in …

b3f1393

…the OptionsListUtils

Remove test created to validate an internal method

22dfe65

wlegolas force-pushed the bugfix/issue-31753 branch from d1009da to 22dfe65 Compare December 3, 2023 09:55

Change method comment with a generic description abouth the tree hier…

3f5b024

…archy indentations

c3024 approved these changes Dec 3, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini December 3, 2023 10:45

neil-marcellini approved these changes Dec 4, 2023

View reviewed changes

neil-marcellini merged commit a4d9bc0 into Expensify:main Dec 4, 2023
14 of 15 checks passed

github-actions bot mentioned this pull request Dec 5, 2023

Deploy Checklist: New Expensify 2023-12-05 #32463

Closed

66 tasks

This was referenced Dec 6, 2023

[HOLD for payment 2024-02-07] [$500] [MEDIUM] Tags: Selected tag in Parent: Child format shows up multiple times in the search result list #32203

Closed

[$500] [Wave 6: Tags] Expense - Selected subcategory shows different view in Tag & Category #32489

Closed

wlegolas deleted the bugfix/issue-31753 branch December 6, 2023 10:42

amyevans mentioned this pull request Dec 8, 2023

[HOLD for payment 2023-12-28] [Wave 6: Tags] Restore tags UI to be non-hierarchical #32735

Closed

waterim mentioned this pull request Dec 13, 2023

Revert "Show child tags indented on the Tag list" #33012

Merged

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show child tags indented on the Tag list #32337

Show child tags indented on the Tag list #32337

wlegolas commented Dec 1, 2023 •

edited

Loading

melvin-bot bot commented Dec 1, 2023

c3024 commented Dec 1, 2023 •

edited

Loading

c3024 commented Dec 1, 2023

c3024 commented Dec 1, 2023 •

edited

Loading

c3024 Dec 2, 2023 •

edited

Loading

wlegolas Dec 3, 2023

c3024 commented Dec 2, 2023

wlegolas commented Dec 3, 2023

wlegolas commented Dec 3, 2023

c3024 commented Dec 3, 2023 •

edited

Loading

c3024 commented Dec 3, 2023

wlegolas commented Dec 4, 2023

neil-marcellini left a comment

OSBotify commented Dec 4, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

		@@ -753,7 +753,7 @@ function sortTags(tags) {
		* @param {Boolean} [isOneLine] - a flag to determine if text should be one line

Show child tags indented on the Tag list #32337

Show child tags indented on the Tag list #32337

Conversation

wlegolas commented Dec 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 1, 2023

c3024 commented Dec 1, 2023 • edited Loading

c3024 commented Dec 1, 2023

c3024 commented Dec 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 Dec 2, 2023 • edited Loading

Choose a reason for hiding this comment

wlegolas Dec 3, 2023

Choose a reason for hiding this comment

c3024 commented Dec 2, 2023

wlegolas commented Dec 3, 2023

wlegolas commented Dec 3, 2023

c3024 commented Dec 3, 2023 • edited Loading

c3024 commented Dec 3, 2023

wlegolas commented Dec 4, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 4, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

wlegolas commented Dec 1, 2023 •

edited

Loading

c3024 commented Dec 1, 2023 •

edited

Loading

c3024 commented Dec 1, 2023 •

edited

Loading

c3024 Dec 2, 2023 •

edited

Loading

c3024 commented Dec 3, 2023 •

edited

Loading