fix: Accounting - Unnecessary tooltip showing the same icon on export page. by Krishna2323 · Pull Request #52436 · Expensify/App

Krishna2323 · 2024-11-12T23:45:42Z

Explanation of Change

Unnecessary tooltip was shown on an export icon.
Although shouldShowTooltip was correctly passed to MultipleAvatars, it wasn't passed further. This PR ensures that the shouldShowTooltip value is passed down to the UserDetailsTooltip and Tooltip components.

Fixed Issues

$ #51656
PROPOSAL: #51656 (comment)

Tests

Precondition:

A workspace with QBO or any accounting integration connected
An expense created and paid

Go to transaction thread of the paid expense
Click on header > Export
Hover over the icon
Verify no tooltip is shown

Verify that no errors appear in the JS console

Offline tests

Precondition:

A workspace with QBO or any accounting integration connected
An expense created and paid

Go to transaction thread of the paid expense
Click on header > Export
Hover over the icon
Verify no tooltip is shown

QA Steps

Precondition:

A workspace with QBO or any accounting integration connected
An expense created and paid

Go to transaction thread of the paid expense
Click on header > Export
Hover over the icon
Verify no tooltip is shown

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

… page. Signed-off-by: krishna2323 <belivethatkg@gmail.com>

melvin-bot · 2024-11-12T23:45:47Z

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

parasharrajat · 2024-11-15T18:22:31Z

I will get this tested by Monday. Thanks for waiting. Meanwhile, @Krishna2323 did you run tests to ensure the changes are not impacting the Avatar component in other places?

Krishna2323 · 2024-11-19T19:59:24Z

@parasharrajat bump

parasharrajat · 2024-11-20T15:46:49Z

@Krishna2323 Can you please update test steps to test all the places where avatar can be present? Let's try to cover most of them.

parasharrajat · 2024-11-20T15:52:42Z

BUG: ROOM avatar does not show tooltip on report header.
BUG: ROOM avatar does not show tooltip on LHN.
BUG: CHATs search does not show tooltip for some of the avatar at the end of list.

20.11.2024_21.21.54_REC.mp4

Krishna2323 · 2024-11-20T16:49:00Z

@parasharrajat, sorry for overlooking. I will soon check the bugs you mentioned.

parasharrajat · 2024-11-21T16:35:16Z

@Krishna2323 Any updates?

Krishna2323 · 2024-11-21T18:58:24Z

@parasharrajat,

ROOM avatar does not show tooltip on report header.
ROOM avatar does not show tooltip on LHN.

It seems like the tooltip was intentionally disabled for room chats but it was showing because of the bug we are fixing.

App/src/pages/home/HeaderView.tsx

Lines 203 to 206 in 0e9f934

    
           <MultipleAvatars 
        
               icons={icons} 
        
               shouldShowTooltip={!isChatRoom || isChatThread} 
        
           />

App/src/components/LHNOptionsList/OptionRowLHN.tsx

Line 259 in 0e9f934

shouldShowTooltip={OptionsListUtils.shouldOptionShowTooltip(optionItem)}

App/src/libs/OptionsListUtils.ts

Lines 1951 to 1953 in 0e9f934

    
           function shouldOptionShowTooltip(option: ReportUtils.OptionData): boolean { 
        
               return (!option.isChatRoom || !!option.isThread) && !option.private_isArchived; 
        
           }

CHATs search does not show tooltip for some of the avatar at the end of list.

As mentioned in the BaseSelectionList component, we only want to show first 10 tooltips because of performance issue. Should we change this?

App/src/components/SelectionList/BaseSelectionList.tsx

Lines 491 to 502 in 075d46b

    
           // We only create tooltips for the first 10 users or so since some reports have hundreds of users, causing performance to degrade. 
        
           const showTooltip = shouldShowTooltips && normalizedIndex < 10; 
        
           return ( 
        
               <View onLayout={(event: LayoutChangeEvent) => onItemLayout(event, item?.keyForList)}> 
        
                   <BaseSelectionListItemRenderer 
        
                       ListItem={ListItem} 
        
                       item={item} 
        
                       index={index} 
        
                       isFocused={isItemFocused} 
        
                       isDisabled={isDisabled} 
        
                       showTooltip={showTooltip}

parasharrajat · 2024-11-22T07:43:31Z

Thanks for looking into these. Can you please update the test steps to test all the places where avatar can be present? Let's try to cover most of them? I believe listing down those places will be enough instead of adding steps for all.

Krishna2323 · 2024-11-24T11:00:21Z

@parasharrajat, I think we should get confirmation before changing the behavior. In my opinion, tooltips for rooms should be shown, as they are also helpful for viewing workspace name and tooltip for user profile is also helpful in viewing full details of users on the participants page. Showing tooltips for only the first 10 users doesn’t seem correct to me.

@thienlnam, could you please take a look?

Monosnap.screencast.2024-11-24.16-26-03.mp4

thienlnam · 2024-11-25T22:07:18Z

Looks fine to have shown on the rooms. Additionally, I don't have context on why we added the restriction to 10, perhaps it was a pre-optimization. We can remove it and always add it back if there's a big performance degredation

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

Krishna2323 · 2024-11-26T22:08:04Z

@parasharrajat, I removed the condition to not show avatars for rooms and also removed the condition to show tooltips for only the first 10 items. The tests are passing, are we good to proceed?

parasharrajat · 2024-11-27T08:32:44Z

Thanks for the changes. But I need to check the requirements for limiting tooltips up to 10 items.

parasharrajat · 2024-11-27T08:40:53Z

        const isItemHighlighted = !!itemsToHighlight?.has(item.keyForList ?? '');
-        // We only create tooltips for the first 10 users or so since some reports have hundreds of users, causing performance to degrade.
-        const showTooltip = shouldShowTooltips && normalizedIndex < 10;



We can't remove this as it as added as a performance improvement. There might not be visual effects in performance but it might impact rendering. Let's not worry about this here. We can open a slack thread for the same if needed. It was added in #26091.

@thiagobrez Any thoughts on why you added this?

@parasharrajat This was just carried over from the old List component when doing the refactor

But it looks like you added it here https://github.com/Expensify/App/pull/26091/files#diff-58e9afec1ac387c92300582afe20b46d7ae577a515cf97f5c4ba58948ad4fd46R249 @thiagobrez. In that case, could you please tell me the name of the file where it was used earlier?

@parasharrajat I believe it was OptionsSelector. Sorry for not being able to provide much more context, as I'm not contributing to Expensify anymore for more than a year :D

You should find more context in the tracker issue here: #11795
And here: #21048

@Krishna2323 I asked the same thing from the author(thiagobrez) above. There is no clear reason for this so far.

oops, I thought that was a different PR where we did the migration. Sorry for that.

Let's create a slack thread for this.

Created a slack thread.

Sorry I can't provide any context as I wasn't the reviewer of that PR, @Santhosh-Sellavel was 😉

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

Krishna2323 · 2024-12-06T19:42:01Z

@parasharrajat @thienlnam, the performance tests are passing, and while testing the PR with a high-traffic account, I couldn't notice any difference in performance.

Monosnap.screencast.2024-12-07.00-42-42.mp4

parasharrajat · 2024-12-07T08:58:20Z


-    // We only create tooltips for the first 10 users or so since some reports have hundreds of users, causing performance to degrade.
-    const displayNamesWithTooltips = ReportUtils.getDisplayNamesWithTooltips((option.participantsList ?? (option.accountID ? [option] : [])).slice(0, 10), shouldUseShortFormInTooltip);
+    const displayNamesWithTooltips = ReportUtils.getDisplayNamesWithTooltips(option.participantsList ?? (option.accountID ? [option] : []), shouldUseShortFormInTooltip);


Let's keep this one. It is important. This only affects the user title.

Thanks for 👀, now updated.

parasharrajat · 2024-12-07T08:59:07Z

-        undefined,
-        ReportUtils.isSelfDM(report),
-    );
+    const displayNamesWithTooltips = ReportUtils.getDisplayNamesWithTooltips(participantPersonalDetailList || [], hasMultipleParticipants, undefined, ReportUtils.isSelfDM(report));


Same here. Let's not touch the report titles. We only discussed list options not option title.

change reverted.

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

parasharrajat · 2024-12-09T19:24:17Z

Screenshots

🔲 iOS / native

10.12.2024_01.01.51_REC.mp4

🔲 iOS / Safari

10.12.2024_00.57.33_REC.mp4

🔲 MacOS / Desktop

10.12.2024_00.58.50_REC.mp4

🔲 MacOS / Chrome

10.12.2024_00.52.15_REC.mp4

🔲 Android / Chrome

10.12.2024_01.14.33_REC.mp4

🔲 Android / native

10.12.2024_01.13.23_REC.mp4

parasharrajat

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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 have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

thienlnam

Great, thanks!

OSBotify · 2024-12-10T02:24:09Z

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

github-actions · 2024-12-10T23:03:27Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 9.0.74-0 🚀

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

github-actions · 2024-12-12T01:33:21Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.74-8 🚀

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

fix: Accounting - Unnecessary tooltip showing the same icon on export…

7caaa26

… page. Signed-off-by: krishna2323 <belivethatkg@gmail.com>

Krishna2323 requested a review from a team as a code owner November 12, 2024 23:45

melvin-bot Bot requested a review from parasharrajat November 12, 2024 23:45

melvin-bot Bot removed the request for review from a team November 12, 2024 23:45

Merge branch 'Expensify:main' into krishna2323/issue/51656

898ef6b

Krishna2323 mentioned this pull request Nov 25, 2024

[HOLD for payment 2024-12-19] [$250] Accounting - Unnecessary tooltip showing the same icon on export page #51656

Closed

8 tasks

Krishna2323 added 2 commits November 26, 2024 19:30

Merge branch 'Expensify:main' into krishna2323/issue/51656

bdb8268

fix: show tooltip for all type of chats and remove tooltips limit.

902806b

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

parasharrajat reviewed Nov 27, 2024

View reviewed changes

Krishna2323 added 2 commits December 7, 2024 00:05

Merge branch 'Expensify:main' into krishna2323/issue/51656

a19cc11

remove list's tooltips limit.

ccb5446

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

parasharrajat reviewed Dec 7, 2024

View reviewed changes

revert changes in SidebarUtils & OptionRow.

1de9712

Signed-off-by: krishna2323 <belivethatkg@gmail.com>

parasharrajat approved these changes Dec 9, 2024

View reviewed changes

melvin-bot Bot requested a review from thienlnam December 9, 2024 19:46

thienlnam approved these changes Dec 10, 2024

View reviewed changes

thienlnam merged commit 709940e into Expensify:main Dec 10, 2024

github-actions Bot mentioned this pull request Dec 10, 2024

Deploy Checklist: New Expensify 2024-12-10 #53889

Closed

52 tasks

Conversation

Krishna2323 commented Nov 12, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Nov 12, 2024

Uh oh!

parasharrajat commented Nov 15, 2024

Uh oh!

Krishna2323 commented Nov 19, 2024

Uh oh!

parasharrajat commented Nov 20, 2024

Uh oh!

parasharrajat commented Nov 20, 2024

Uh oh!

Krishna2323 commented Nov 20, 2024

Uh oh!

parasharrajat commented Nov 21, 2024

Uh oh!

Krishna2323 commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parasharrajat commented Nov 22, 2024

Uh oh!

Krishna2323 commented Nov 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thienlnam commented Nov 25, 2024

Uh oh!

Krishna2323 commented Nov 26, 2024

Uh oh!

parasharrajat commented Nov 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Krishna2323 commented Dec 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

parasharrajat commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

Uh oh!

parasharrajat left a comment

Choose a reason for hiding this comment

Krishna2323 commented Nov 21, 2024 •

edited

Loading

Krishna2323 commented Nov 24, 2024 •

edited

Loading

parasharrajat commented Dec 9, 2024 •

edited

Loading