Refactor Hoverable component into functional #29052

kacper-mikolajczak · 2023-10-07T13:27:15Z

Details

PR focuses on rewriting the Hoverable component from class-based approach to functional one.

It builds upon previous PR #27223 and fixes errors reported in the #28634 issue.

Fixed Issues

$ #16161
PROPOSAL: #16161 (comment)

Tests

Hover over LHN list
Hover over chat messages element and its reaction box items
Hover over emoji picker
Open emoji picker
Hover over attachment picker menu
Open attachment menu
Hover over user/workspace avatar
Open settings
Open workspaces tab
Go back
Go back

Verify that there are no crashes/errors after all steps performed

Offline tests

N/A

QA Steps

Hover over LHN list
Hover over chat messages element and its reaction box items
Hover over emoji picker
Open emoji picker
Hover over attachment picker menu
Open attachment menu
Hover over user/workspace avatar
Open settings
Open workspaces tab
Close tab by going back by using arrow button

Verify that there are no crashes/errors after all steps performed

PR Author Checklist

Screenshots/Videos

Web

hoverable_tests_web.mp4

Mobile Web - Chrome

hoverable_tests_mandroid.mov

Mobile Web - Safari

hoverable_tests_mios.mp4

Desktop

hoverable_tests_desktop.mov

iOS

hoverable_tests_ios.mp4

Android

hoverable_tests_android.mp4

rezkiy37 · 2023-10-09T09:30:45Z

src/components/Hoverable/index.js

 import {DeviceEventEmitter} from 'react-native';
 import {propTypes, defaultProps} from './hoverablePropTypes';
 import * as DeviceCapabilities from '../../libs/DeviceCapabilities';
 import CONST from '../../CONST';

+function mapChildren(children, callbackParam) {


I think about adding comments for mapChildren and assignRef to clarify why we have this logic.

Thanks for the idea, done ✅

Thank you, looks good!

@kacper-mikolajczak, do we need to extract this logic outside of the component? Usually, if logic is extracted should be moved to utils or helpers dir

@ArekChr Those helpers are not really that universal to move them into utils - I did not want to bloat the component body no more, thus extracted them away. This might help to reduce the cognitive load when studying the component, wdyt?

If not, is there a convention we use for such local helpers? Shall we create a separate file under component's directory called utils/helpers?

Thanks for pointing this out!

I agree that local functions simplify readability. For me, it can stay as it is. But assignRef seems to be a universal function. It could be moved to, e.g. react utils or helpers. @Beamanator, any thoughts?

rezkiy37

Left a few minor comments.

src/components/Hoverable/index.js

melvin-bot · 2023-10-09T10:25:16Z

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

ArekChr · 2023-10-09T10:57:08Z

src/components/Hoverable/index.js

+
+    const child = useMemo(() => React.Children.only(mapChildren(children, isHovered)), [children, isHovered]);
+
+    const onMouseEnter = useCallback(


The method should be named for what it does and never what callback they handle, the same for onMouseLeave and onBlur

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

ArekChr · 2023-10-09T11:44:20Z

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 / Chrome
- iOS / native
- iOS / 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

Web

web.mov

Mobile Web - Chrome

mweb.chrome.mov

Mobile Web - Safari

mweb.safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

ArekChr · 2023-10-10T09:44:13Z

src/components/Hoverable/index.js


    /**
     * Checks the hover state of a component and updates it based on the event target.
     * This is necessary to handle cases where the hover state might get stuck due to an unreliable mouseleave trigger,
     * such as when an element is removed before the mouseleave event is triggered.
     * @param {Event} e - The hover event object.
     */
-    checkHover(e) {
-        if (!this.wrapperView || !this.state.isHovered) {
+    const unsetHoveredIfOutside = useCallback(


This function could be inside useEffect with mouseover listener as it is not used anywhere else

Beamanator · 2023-10-12T14:45:58Z

Argggg I was too late reviewing this and now we have conflicts 😅

@kacper-mikolajczak are you able to resolve conflicts tonight / tomorrow? 🙏

Also the manual test steps are a bit sparse, can you please add more test steps for more places this component is used so we are super unlikely to cause any regressions? 🙏

kacper-mikolajczak · 2023-10-12T14:53:08Z

Hi @Beamanator no worries! I will resolve conflicts and add the tests you've mentioned tomorrow 👍

Beamanator · 2023-10-12T14:57:04Z

Thanks very much @kacper-mikolajczak ! 👍

kacper-mikolajczak · 2023-10-13T09:51:21Z

Hi @Beamanator! 👋 I've resolved merge conflicts and updated QA steps. Let me know if everything works for you as well! 👍

Beamanator

LGTM!

OSBotify · 2023-10-17T08:43:29Z

✋ 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-10-17T23:57:37Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.86-0 🚀

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

OSBotify · 2023-10-18T23:55:06Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

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

kacper-mikolajczak added 6 commits October 6, 2023 13:36

fix refs

a839a64

fix Tooltip memoization

95ce7ae

Merge branch 'main' into refactor/16161/hoverable-class-to-functional

70999e7

obey the forwardRef tips

c9eb5a7

fix Tooltip and BaseTooltip as wrong file was changed

16cabc5

remove unnecessary memo in Tooltip

b5f9a86

rezkiy37 reviewed Oct 9, 2023

View reviewed changes

add clarification comments

5461a71

rezkiy37 reviewed Oct 9, 2023

View reviewed changes

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

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

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

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

MrMuzyk approved these changes Oct 9, 2023

View reviewed changes

kacper-mikolajczak marked this pull request as ready for review October 9, 2023 10:25

kacper-mikolajczak requested a review from a team as a code owner October 9, 2023 10:25

melvin-bot bot requested review from ArekChr and removed request for a team October 9, 2023 10:25

ArekChr reviewed Oct 9, 2023

View reviewed changes

rezkiy37 approved these changes Oct 9, 2023

View reviewed changes

Add meaningful names to event callbacks

0246282

kacper-mikolajczak requested a review from ArekChr October 10, 2023 07:47

Merge branch 'main' into refactor/16161/hoverable-class-to-functional

a4a4ea0

ArekChr reviewed Oct 10, 2023

View reviewed changes

incorporate unsetHoveredIfOutside into useEffect

599b119

ArekChr approved these changes Oct 10, 2023

View reviewed changes

melvin-bot bot requested a review from Beamanator October 10, 2023 10:02

Merge branch 'main' into refactor/16161/hoverable-class-to-functional

c585d31

Beamanator approved these changes Oct 17, 2023

View reviewed changes

Beamanator merged commit 91e2120 into Expensify:main Oct 17, 2023
12 checks passed

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

youssef-lr mentioned this pull request Oct 18, 2023

[CP Staging] Revert "Remove withNavigationFallback.js HOC" #29844

Merged

57 tasks

melvin-bot bot mentioned this pull request Oct 18, 2023

Migrate index.js to function component #16161

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Hoverable component into functional #29052

Refactor Hoverable component into functional #29052

kacper-mikolajczak commented Oct 7, 2023 •

edited

Loading

rezkiy37 Oct 9, 2023

kacper-mikolajczak Oct 9, 2023

rezkiy37 Oct 9, 2023

ArekChr Oct 9, 2023

kacper-mikolajczak Oct 9, 2023 •

edited

Loading

ArekChr Oct 10, 2023

rezkiy37 left a comment

melvin-bot bot commented Oct 9, 2023

ArekChr Oct 9, 2023

kacper-mikolajczak Oct 9, 2023

ArekChr commented Oct 9, 2023 •

edited

Loading

ArekChr Oct 10, 2023

kacper-mikolajczak Oct 10, 2023

Beamanator commented Oct 12, 2023

kacper-mikolajczak commented Oct 12, 2023

Beamanator commented Oct 12, 2023

kacper-mikolajczak commented Oct 13, 2023

Beamanator left a comment

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023


		const child = useMemo(() => React.Children.only(mapChildren(children, isHovered)), [children, isHovered]);

		const onMouseEnter = useCallback(

Refactor Hoverable component into functional #29052

Refactor Hoverable component into functional #29052

Conversation

kacper-mikolajczak commented Oct 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kacper-mikolajczak Oct 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArekChr commented Oct 9, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Beamanator commented Oct 12, 2023

kacper-mikolajczak commented Oct 12, 2023

Beamanator commented Oct 12, 2023

kacper-mikolajczak commented Oct 13, 2023

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

kacper-mikolajczak commented Oct 7, 2023 •

edited

Loading

kacper-mikolajczak Oct 9, 2023 •

edited

Loading

ArekChr commented Oct 9, 2023 •

edited

Loading