Improve ActiveHoverable CPU performance #54744

zirgulis · 2025-01-02T09:27:19Z

Explanation of Change

The ActiveHoverable component manages hover states for interactive elements in our web interface. The original implementation used multiple event listeners, including a global document-level mouseover listener, which was causing performance overhead, especially in views with many hoverable elements.

Fixed Issues

$ #55652
PROPOSAL:

Optimize hover state management by:

Removing the global document-level mouseover listener
Using component-level mouse events only
Implementing efficient state tracking with isHoveredRef

Tests

ActiveHoverable component is used everywhere across the web/desktop application, therefore it's CRUCIAL to test and validate that it works the same as before.

Testing steps:

Hover on multiple components, ensure that all hoverable elements are hovered and their states transition properly.
Scroll on the list of items, e.g. chat messages. When the scrolling stops the mouse cursor should stop on a list item and hover it. (see in the video attached)
When switching between different desktop screens the mouse cursor should stop on a hoverable item and should highlight the selected item. Changing the the mouse position and then switching back the screen should hover on the item underneath. (see in the video attached)

Offline tests

Testing steps:

Hover on multiple components, ensure that all hoverable elements are hovered and their states transition properly.
Scroll on the list of items, e.g. chat messages. When the scrolling stop the mouse cursor should stop on a list item and hover it. (see in the video attached)
When switching between different desktop screens the mouse cursor should stop on a hoverable item and should highlight the selected item. Changing the the mouse position and then switching back the screen should hover on the item underneath. (see in the video attached)

QA Steps

Testing steps:

Hover on multiple components, ensure that all hoverable elements are hovered and their states transition properly.
Scroll on the list of items, e.g. chat messages. When the scrolling stop the mouse cursor should stop on a list item and hover it. (see in the video attached)
When switching between different desktop screens the mouse cursor should stop on a hoverable item and should highlight the selected item. Changing the the mouse position and then switching back the screen should hover on the item underneath. (see in the video attached)

Fullstory testing:

use the fullstory appluase testing email
find the session from staging
watch it and make sure the clicking events are all captured fine and there is nothing odd about the session

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-01-22.at.17.15.26.mp4

MacOS: Desktop

Screen.Recording.2025-01-22.at.17.22.10.mp4

…to zirgulis/improve-ActiveHoverable-cpu-performance

github-actions · 2025-01-10T22:50:09Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2025-01-10T23:14:22Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/54744/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/54744/NewExpensify.dmg	https://54744.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

melvin-bot · 2025-01-22T16:21:55Z

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

zirgulis · 2025-01-22T16:22:07Z

@mountiny I'm not sure what are the testing steps for the Fullstory QA part, therefore left as TBD in PR's the description

mountiny · 2025-01-22T18:05:24Z

I have added some generic steps, I am also not sure about anything specific to check but mainly just checking if the sessions are looking fine

amyevans · 2025-01-22T20:23:12Z

@zirgulis is there a GH issue this is associated with? And is this ready for C+ review/testing or not yet?

zirgulis · 2025-01-23T05:10:29Z

@amyevans this PR is related to this proposal posted here and I think it's also ready for C+ review/testing

mountiny · 2025-01-23T12:50:39Z

It is coming from this thread in quality https://expensify.slack.com/archives/C05LX9D6E07/p1736326697079059

Made an issue for it and assigned you all 🙌 #55652

@brunovjk can you please complete the review and testing?

@amyevans for the QA I think the crucial part is to ensure in staging that the fullstory sessios are recorded just fine even after this change (hence InternalQA)

brunovjk · 2025-01-23T14:40:40Z

@brunovjk can you please complete the review and testing?

I'm afk for a couple of hours, I will review it as soon as I get home. If it's urgent, please reassign

amyevans · 2025-01-23T21:12:47Z

Okay great, thanks for creating the issue!

@amyevans for the QA I think the crucial part is to ensure in staging that the fullstory sessios are recorded just fine even after this change (hence InternalQA)

Cool, I verified I see sessions in FS currently following the fullstory+____+@applause.expensifail.com pattern in the staging environment, so I know what to look for once we get this on staging.

brunovjk · 2025-01-23T23:41: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 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 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 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.ts 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 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.
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

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

54744_chrome.mov

54744_chrome_perf_result.mov

MacOS: Desktop

54744_desktop.mov

brunovjk

Looking good to me.

zirgulis · 2025-01-24T14:31:04Z

@mountiny do we need any more reviewers/approvals?

amyevans · 2025-01-24T16:09:52Z

@mountiny you want to take a look too or nah?

mountiny · 2025-01-24T20:45:36Z

@amyevans All good, going to merge it now that you approved, thank you!

OSBotify · 2025-01-24T20:54:35Z

✋ 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 · 2025-01-28T02:15:52Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.90-0 🚀

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

amyevans · 2025-01-28T15:40:58Z

✅ Internal QA passes on staging

github-actions · 2025-01-29T06:23:41Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

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

ishpaul777 · 2025-03-11T20:17:14Z

src/components/Hoverable/ActiveHoverable.tsx

-            if (!elementRef.current?.contains(event.target as Node) && !elementRef.current?.contains(event.relatedTarget as Node) && !shouldFreezeCapture) {
-                setIsHovered(false);
-            }


removing this logic caused a regression here #57022, we fix it removing the whole logic for onblur, as it was no longer relevant.

zirgulis added 4 commits January 2, 2025 11:19

improve ActiveHoverable CPU performance

118212b

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

41df088

…to zirgulis/improve-ActiveHoverable-cpu-performance

fix hover close

a8a191c

fix eslint error

a1e4533

mountiny added the Ready To Build label Jan 10, 2025

mountiny assigned zirgulis Jan 21, 2025

zirgulis marked this pull request as ready for review January 22, 2025 16:21

zirgulis requested a review from a team as a code owner January 22, 2025 16:21

melvin-bot bot requested a review from amyevans January 22, 2025 16:21

melvin-bot bot removed the request for review from a team January 22, 2025 16:21

mountiny added the InternalQA This pull request required internal QA label Jan 22, 2025

mountiny requested a review from brunovjk January 23, 2025 12:49

brunovjk approved these changes Jan 23, 2025

View reviewed changes

amyevans approved these changes Jan 24, 2025

View reviewed changes

mountiny merged commit cfc5400 into Expensify:main Jan 24, 2025
23 checks passed

brunovjk mentioned this pull request Jan 25, 2025

[HOLD for payment 2025-02-05] [$250] Optimize hover state management #55652

Closed

jjcoffee mentioned this pull request Jan 27, 2025

[Internal QA]: feat: Unmask tooltip copy for Fullstory #55650

Merged

50 tasks

github-actions bot mentioned this pull request Jan 28, 2025

Deploy Checklist: New Expensify 2025-01-28 #55824

Closed

82 tasks

linhvovan29546 mentioned this pull request Feb 18, 2025

[Due for payment 2025-03-13] [$250] Web - Action menu - Pressing tab does not navigate through action menu badges #57022

Closed

8 tasks

Krishna2323 mentioned this pull request Feb 19, 2025

Video controls are hidden in some cases #57054

Closed

8 tasks

ishpaul777 reviewed Mar 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve ActiveHoverable CPU performance #54744

Improve ActiveHoverable CPU performance #54744

zirgulis commented Jan 2, 2025 •

edited by amyevans

Loading

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025

melvin-bot bot commented Jan 22, 2025

zirgulis commented Jan 22, 2025

mountiny commented Jan 22, 2025

amyevans commented Jan 22, 2025

zirgulis commented Jan 23, 2025

mountiny commented Jan 23, 2025

brunovjk commented Jan 23, 2025

amyevans commented Jan 23, 2025

brunovjk commented Jan 23, 2025

brunovjk left a comment

zirgulis commented Jan 24, 2025

amyevans commented Jan 24, 2025

mountiny commented Jan 24, 2025

OSBotify commented Jan 24, 2025

github-actions bot commented Jan 28, 2025

amyevans commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

ishpaul777 Mar 11, 2025

Improve ActiveHoverable CPU performance #54744

Improve ActiveHoverable CPU performance #54744

Conversation

zirgulis commented Jan 2, 2025 • edited by amyevans Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025

melvin-bot bot commented Jan 22, 2025

zirgulis commented Jan 22, 2025

mountiny commented Jan 22, 2025

amyevans commented Jan 22, 2025

zirgulis commented Jan 23, 2025

mountiny commented Jan 23, 2025

brunovjk commented Jan 23, 2025

amyevans commented Jan 23, 2025

brunovjk commented Jan 23, 2025

Reviewer Checklist

Screenshots/Videos

brunovjk left a comment

Choose a reason for hiding this comment

zirgulis commented Jan 24, 2025

amyevans commented Jan 24, 2025

mountiny commented Jan 24, 2025

OSBotify commented Jan 24, 2025

github-actions bot commented Jan 28, 2025

amyevans commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

ishpaul777 Mar 11, 2025

Choose a reason for hiding this comment

zirgulis commented Jan 2, 2025 •

edited by amyevans

Loading