Skip to content

Refactor avatar tooltips to remove shouldShowTooltip - #97961

Merged
roryabraham merged 7 commits into
Expensify:mainfrom
software-mansion-labs:chore/refactor-avatar-tooltips
Aug 11, 2026
Merged

Refactor avatar tooltips to remove shouldShowTooltip#97961
roryabraham merged 7 commits into
Expensify:mainfrom
software-mansion-labs:chore/refactor-avatar-tooltips

Conversation

@jmusial

@jmusial jmusial commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Extracts avatar tooltip logic out of the individual avatar layout components into dedicated reusable AvatarTooltip/AvatarNamesTooltip components with an AvatarTooltipContext for disabling tooltips, deduplicating tooltip wiring across layouts and their call sites.

Fixed Issues

$ #94586
PROPOSAL:

Tests

Only on web

Test 1 — tooltips shown (unchanged behavior):

  1. Open the app
  2. Hover over the avatar in any non-archived LHN chat row
  3. Verify the user-details tooltip appears with that user's display name
  4. Navigate to Spend > Expense reports and hover over the first on the left in a report row
  5. Verify the user-details tooltip appears with that user's display name

Test 2 — tooltips suppressed for archived rooms

  1. Open the app
  2. Locate an archived chat in the LHN (e.g. a closed workspace room — search for it if not visible)
  3. Hover over its avatar in the LHN row
  4. Verify no tooltip appears
  5. Navigate to Spend > Expense reports and hover over the "From"/"To" avatars in a report row
  6. Verify no tooltip appears

Offline tests

Same as tests

QA Steps

Same as tests

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
  • 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 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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

Videos just for web - mobile does not have tooltips anyways.

MacOS: Chrome / Safari
Screen.Recording.2026-08-10.at.11.18.43.mov

@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/App.tsx 100.00% <ø> (ø)
src/components/Avatar/connected/AccountAvatar.tsx 100.00% <100.00%> (ø)
src/components/Avatar/layouts/DiagonalAvatars.tsx 100.00% <100.00%> (ø)
...rc/components/Avatar/layouts/HorizontalAvatars.tsx 100.00% <100.00%> (ø)
...onents/Avatar/layouts/PressableDiagonalAvatars.tsx 100.00% <100.00%> (ø)
...onents/Avatar/layouts/PressableSubscriptAvatar.tsx 100.00% <100.00%> (ø)
src/components/Avatar/layouts/SingleAvatar.tsx 100.00% <100.00%> (ø)
src/components/Avatar/layouts/SubscriptAvatar.tsx 100.00% <100.00%> (ø)
...ponents/Avatar/layouts/SubscriptCardFeedAvatar.tsx 100.00% <100.00%> (ø)
.../components/Avatar/tooltips/AvatarNamesTooltip.tsx 100.00% <100.00%> (ø)
... and 20 more
... and 10 files with indirect coverage changes

@jmusial

jmusial commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: 81f1f3125d

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@Guccio163 Guccio163 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, I'd add some unit tests for the new components (AvatarTooltip, AvatarNamesTooltip, AvatarTooltipContext)

@jmusial
jmusial marked this pull request as ready for review August 10, 2026 13:50
@jmusial
jmusial requested review from a team as code owners August 10, 2026 13:50
@melvin-bot
melvin-bot Bot requested review from eVoloshchak and garrettmknight and removed request for a team August 10, 2026 13:50
@melvin-bot

melvin-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

@eVoloshchak 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 removed the request for review from a team August 10, 2026 13:50
@jmusial

jmusial commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

cc. @roryabraham - side quest to remove shouldShowTooltip prop drill

@garrettmknight
garrettmknight removed their request for review August 10, 2026 15:46
roryabraham
roryabraham previously approved these changes Aug 10, 2026

@roryabraham roryabraham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I was on the edge about whether these these comments should be blockers, but I guess they're not: this PR is definitely a nice improvement.

I'd recommend making the two changes I requested. Chatting with Claude about the risks of the useContext -> use change, I think it should be pretty safe to do.

*/
function AvatarNamesTooltip({avatars, children}: AvatarNamesTooltipProps) {
const areTooltipsDisabled = useAreAvatarTooltipsDisabled();
const {formatPhoneNumber, translate} = useLocalize();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

NAB, but an interesting note I think is worth considering. If we update useLocalize to use use instead of useContext under the hood, then it can be called conditionally, which would mean we can subscribe to the locale context only if areTooltipsDisabled is false.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It is interesting, but not sure if worth. The subscription only cost is negligible and in the case useLocalize that rarely changes values I don't this we're bearing any re render costs here.

}>;

/** Suppresses `AvatarTooltip` and `AvatarNamesTooltip` for every avatar rendered inside. */
function AvatarTooltipsDisabled({isDisabled = true, children}: AvatarTooltipsDisabledProps) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

When I saw this, I was expecting to see a default provider very high in the tree (i.e: AuthScreens?) that sets isDisabled = false, preventing all avatar tooltips from becoming a no-op if not wrapped in the context lower in the tree.

@jmusial jmusial Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Could but it works the same w/o having a top lvl one. Will be good from clarity perspective.

I'll leave as is here - this PR I treat it as a step, not a final solution.

Ideally we'll have similar TooltipsDisabled that will come from reworked Tooltips the will replace AvatarTooltipsDisabled.

}>;

/** Suppresses `AvatarTooltip` and `AvatarNamesTooltip` for every avatar rendered inside. */
function AvatarTooltipsDisabled({isDisabled = true, children}: AvatarTooltipsDisabledProps) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Also, I'm kind of wondering if this falls under the same umbrella as no-negated-variable-names lint rule. Maybe it should be AvatarTooltipsContextProvider, with isEnabled defaulting to true, and then to disable it you pass isEnabled={false}.

I think that's a bit more inline with the spirit of that custom lint rule.

@jmusial jmusial Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Given this and prev comment I think I'll rework it with global context providing default.

@jmusial

jmusial commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

@eVoloshchak all yours

@eVoloshchak

eVoloshchak commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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 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)
  • 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)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • 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
    • 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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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

MacOS: Chrome / Safari
Screen.Recording.2026-08-11.at.16.41.25.mov
Screen.Recording.2026-08-11.at.16.39.08.mov

@eVoloshchak

Copy link
Copy Markdown
Contributor

Looks and tests well!
@jmusial, Unit Tests check is failing on useReportActionAvatarsTranslateTest

@eVoloshchak eVoloshchak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot
melvin-bot Bot requested a review from roryabraham August 11, 2026 16:00
@quinthar quinthar added the #quality Relates to work in the #quality room label Aug 11, 2026
@roryabraham
roryabraham merged commit 5ffd0f6 into Expensify:main Aug 11, 2026
36 of 38 checks passed
@OSBotify

Copy link
Copy Markdown
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.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 roryabraham has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.4.53-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site changes required

I reviewed the changes in this PR and no updates to Expensify's help site files under docs/articles are required.

Why: This is a pure internal code refactor. It extracts avatar tooltip logic out of the individual avatar layout components into reusable AvatarTooltip/AvatarNamesTooltip components with an AvatarTooltipContext, deduplicating tooltip wiring across layouts and their call sites. The PR's own test plan confirms this is unchanged behavior — tooltips still show the user's display name on hover where they did before, and are still suppressed for archived rooms.

The help site documents user-facing features and workflows, not internal component architecture. Since there is no observable change to what users see or do, there is nothing to add or update in the docs. No draft PR was created — there's no linked help site PR to review.

@jmusial, if you believe a user-facing behavior did change here that should be documented, let me know and I'll draft the help site update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

#quality Relates to work in the #quality room

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants