Fix tagList highlight #31652

luacmartins · 2023-11-21T18:49:51Z

Details

We started rendering enabledTags in this PR, but we were still using policyTagList to define the initialFocusedIndex which threw off the indexes

Fixed Issues

$ #31578

Tests

Precondition: enable tags as a workspace's admin following these instructions

Navigate to NewDot and log in as an employee
Click on FAB > Request money
Enter amount and select workspace
Click on Show more > Tags
Select any option
Open the tags label again
Verify that only the selected tag is highlighted

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

Verify that no errors appear in the JS console

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 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 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(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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

melvin-bot · 2023-11-21T18:50:00Z

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

srikarparsi

lgtm

srikarparsi · 2023-11-21T18:58:44Z

lint looks to be failing @luacmartins

melvin-bot · 2023-11-21T20:05:52Z

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

situchan · 2023-11-21T20:39:49Z

reviewing this (coming from https://expensify.slack.com/archives/C01GTK53T8Q/p1700598717809329)

src/components/TagPicker/index.js

situchan · 2023-11-21T21:54:09Z

I think I found the root cause why not working on edit case:

enabledTags changes order of tags so selected tags are showing first:

App/src/components/TagPicker/index.js

Line 56 in da549c0

    
           const tags = [...selectedOptions, ..._.filter(policyTagList, (policyTag) => policyTag.enabled && !selectedNames.includes(policyTag.name))];

src/components/TagPicker/index.js

situchan · 2023-11-21T22:23:24Z

You can test and verify fix by console logging initialFocusedIndex and disabling some tags in oldDot.
We should still use enabledTags instead of policyTagList in _.chain() (which was your original fix). Otherwise it will cause issue when some tags are disabled.

situchan · 2023-11-21T22:46:11Z

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

Screen.Recording.2023-11-22.at.4.44.56.AM.mov

MacOS: Desktop

luacmartins · 2023-11-21T22:48:11Z

I applied my original fix and the latest changes, but I still see the issue with 3 or more tags 🤔

situchan · 2023-11-21T22:49:00Z

Can you please share your video?

luacmartins · 2023-11-21T22:55:51Z

This is what I'm seeing, but I don't quite understand why since logging policyTagList just before this _.filter returns the object in order, but enabledTags is out of order again

Screen.Recording.2023-11-21.at.3.54.12.PM.mov

situchan · 2023-11-21T23:05:51Z

This is what I'm seeing, but I don't quite understand why since logging policyTagList just before this _.filter returns the object in order, but the _.filter seems to loop it out of order.

Please try lodash filter instead of underscore or native method - Object.values().filter()
Objects sort sometimes don't work well

luacmartins · 2023-11-21T23:13:55Z

I tried that and they also didn't work

luacmartins · 2023-11-21T23:22:06Z

Ok, I pushed a fix that sorts the tag names first and then filters them. That's in line with what we do here

src/components/TagPicker/index.js

situchan · 2023-11-22T00:03:34Z

src/components/TagPicker/index.js

+        const sortedTagList = _.chain(policyTagList)
+            .values()
+            .sortBy((policyTag) => policyTag.name)
+            .value();


Let's add policyTag.enabled filter logic here as we don't show disabled tags in any case

As you see, wrong index after I disable 2nd tag, though not visually noticeable

Screen.Recording.2023-11-22.at.6.01.51.AM.mov

situchan · 2023-11-22T00:06:20Z

src/components/TagPicker/index.js

+        if (!shouldShowDisabledAndSelectedOption) {
+            return sortedTagList;
+        }


Actually I don't see the need of this early return.
Can't we apply same logic to both new request and edit request?

I'm not too sure either. The name suggests that we display disabled tags, but I'm not sure that that's happening

@tienifr @robertKozik could you check this logic? It seems like we'd want to return the policyTagList if shouldShowDisabledAndSelectedOption is true and not the inverse like we have in the code, right?

situchan · 2023-11-23T00:41:41Z

@luacmartins please pull main. The issue we're concerning about was already happening on production. #31475 was just merged

luacmartins · 2023-11-23T18:54:22Z

Ah so this has been solved already. Gonna close the PR.

fix tagList highlight

d0dee28

luacmartins self-assigned this Nov 21, 2023

luacmartins marked this pull request as ready for review November 21, 2023 18:49

luacmartins requested a review from a team as a code owner November 21, 2023 18:49

melvin-bot bot requested review from robertKozik and removed request for a team November 21, 2023 18:49

luacmartins requested a review from srikarparsi November 21, 2023 18:50

srikarparsi previously approved these changes Nov 21, 2023

View reviewed changes

fix lint

0c9edf6

luacmartins dismissed srikarparsi’s stale review via 0c9edf6 November 21, 2023 19:58

luacmartins requested review from srikarparsi and a team November 21, 2023 20:05

melvin-bot bot requested review from ntdiary and removed request for a team November 21, 2023 20:05

srikarparsi previously approved these changes Nov 21, 2023

View reviewed changes

luacmartins removed the request for review from ntdiary November 21, 2023 20:26

luacmartins requested a review from situchan November 21, 2023 20:50

situchan reviewed Nov 21, 2023

View reviewed changes

src/components/TagPicker/index.js Show resolved Hide resolved

revert initial changes, update logic

c64984e

luacmartins dismissed srikarparsi’s stale review via c64984e November 21, 2023 22:05

luacmartins requested review from srikarparsi and situchan November 21, 2023 22:06

luacmartins added 2 commits November 21, 2023 15:06

rm empty line

07e6716

dont use values

07fd587

situchan reviewed Nov 21, 2023

View reviewed changes

src/components/TagPicker/index.js Show resolved Hide resolved

update initialFocusedIndex

53213f3

sort tags first

4ddac94

luacmartins requested a review from situchan November 21, 2023 23:22

situchan reviewed Nov 21, 2023

View reviewed changes

src/components/TagPicker/index.js Outdated Show resolved Hide resolved

sort both tag lists

850d8f6

luacmartins requested a review from situchan November 21, 2023 23:42

situchan reviewed Nov 22, 2023

View reviewed changes

luacmartins changed the title ~~[CP Stag] Fix tagList highlight~~ Fix tagList highlight Nov 22, 2023

luacmartins closed this Nov 23, 2023

situchan mentioned this pull request Nov 23, 2023

[HOLD for Payment 2023-12-04] Request money - Two options are highlighted after opening tag label second time #31578

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix tagList highlight #31652

Fix tagList highlight #31652

luacmartins commented Nov 21, 2023 •

edited

Loading

melvin-bot bot commented Nov 21, 2023

srikarparsi left a comment

srikarparsi commented Nov 21, 2023

melvin-bot bot commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

luacmartins commented Nov 21, 2023

situchan commented Nov 21, 2023

luacmartins commented Nov 21, 2023 •

edited

Loading

situchan commented Nov 21, 2023

luacmartins commented Nov 21, 2023

luacmartins commented Nov 21, 2023

situchan Nov 22, 2023

situchan Nov 22, 2023

luacmartins Nov 22, 2023

luacmartins Nov 22, 2023

situchan commented Nov 23, 2023

luacmartins commented Nov 23, 2023

Fix tagList highlight #31652

Fix tagList highlight #31652

Conversation

luacmartins commented Nov 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 21, 2023

srikarparsi left a comment

Choose a reason for hiding this comment

srikarparsi commented Nov 21, 2023

melvin-bot bot commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

situchan commented Nov 21, 2023

Reviewer Checklist

Screenshots/Videos

luacmartins commented Nov 21, 2023

situchan commented Nov 21, 2023

luacmartins commented Nov 21, 2023 • edited Loading

situchan commented Nov 21, 2023

luacmartins commented Nov 21, 2023

luacmartins commented Nov 21, 2023

situchan Nov 22, 2023

Choose a reason for hiding this comment

situchan Nov 22, 2023

Choose a reason for hiding this comment

luacmartins Nov 22, 2023

Choose a reason for hiding this comment

luacmartins Nov 22, 2023

Choose a reason for hiding this comment

situchan commented Nov 23, 2023

luacmartins commented Nov 23, 2023

luacmartins commented Nov 21, 2023 •

edited

Loading

luacmartins commented Nov 21, 2023 •

edited

Loading