Hoverable component refactored from class into functional approach #27223

kacper-mikolajczak · 2023-09-12T08:55:58Z

Details

In this PR Hoverable component was re-written from class to functional approach.

Fixed Issues

$ #16161
PROPOSAL: #16161 (comment)

Tests

For platforms with hover:

Hover over hoverable surfaces (e.g. chats' titles, avatars, menu buttons)
Check if tooltip and hover styles are shown correctly

For platforms without hover:

Check if buttons (pressables) are accessible

Offline tests

QA Steps

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Hoverable_web.mov

Mobile Web - Chrome

Hoverable_web_android.mov

Mobile Web - Safari

Hoverable_web_ios.mov

Desktop

Hoverable_desktop.mov

iOS

Hoverable_ios.mov

Android

Hoverable_android.mov

github-actions · 2023-09-12T08:56:13Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

kacper-mikolajczak · 2023-09-12T09:09:38Z

I have read the CLA Document and I hereby sign the CLA

kacper-mikolajczak · 2023-09-12T09:10:23Z

recheck

gedu · 2023-09-12T09:31:25Z

src/components/Hoverable/index.js

-        });
-    }
+
+function Hoverable({disabled, onHoverIn, onHoverOut, children}) {


Not seeing that you are exporting the Hoverable component

gedu · 2023-09-12T09:32:16Z

src/components/Hoverable/index.js

+        onMouseEnter,
+        onMouseLeave,
+        onBlur,
+    });
 }

 Hoverable.propTypes = propTypes;
 Hoverable.defaultProps = defaultProps;


Add a displayName field

Hoverable.displayName = 'Hoverable';

AFAIK, there is no need to set displayName explicitly on components. Should we propose an update to the style doc you've mentioned? Thanks for noticing that!

Yeah, but this standard is from Expensify codebase

Sure, let's keep it this way then :)

gedu · 2023-09-12T09:38:52Z

src/components/Hoverable/index.js

+    }, [disabled]);
+
+    useEffect(() => {
+        if (isHovered) return onHoverIn();


I think here is missing the check if (disabled) { return; } before doing any onHoverXXX

That's a great point! I think we can discuss how flow with disabled could look like, as it is now conflicting with internal isHovered state declaration (for example we are not prohibiting event handlers to be executed even if disabled is set to true)

teneeto · 2023-09-12T09:45:06Z

src/components/Hoverable/index.js

+
+            if (_.isFunction(child.props.onBlur)) child.props.onBlur(el);
+        },
+        [child],


@gedu, should we list dependency as child or child.props.onBlur ?

teneeto · 2023-09-12T09:52:19Z

@kacper-mikolajczak check and thick all boxes and add screenshots/videos for all platforms.

src/components/Hoverable/index.js

melvin-bot · 2023-09-13T12:30:48Z

@ArekChr @ One of you needs to 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-09-15T09:39:21Z

src/components/Hoverable/index.js

-
-    componentDidMount() {
-        document.addEventListener('visibilitychange', this.handleVisibilityChange);
-        document.addEventListener('mouseover', this.checkHover);


@kacper-mikolajczak It seems this listener has been not migrated, checkHover is not needed anymore?

Great catch, thanks! Done ✅

src/components/Hoverable/index.js

ArekChr

@kacper-mikolajczak Overall, the code changes look good. I left some minor comments. Please also complete the checklist. Thanks!

ArekChr · 2023-09-18T11:45:27Z

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

All good, thanks for PR!

teneeto · 2023-09-19T06:13:51Z

LGTM!

melvin-bot · 2023-09-25T09:27:39Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #16161 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

Beamanator · 2023-09-26T01:47:58Z

Are we waiting on @hurali97 to review or are we good to move forward since @ArekChr reviewed? 😅

hurali97 · 2023-09-26T07:31:57Z

Hey folks, I will give a review today 🤞

hurali97

@kacper-mikolajczak Looks good, nice work 🎉 I have a single comment and would be cool if you can get that in or discuss 👍 I tested with updated changes and it works well too.

The reason I brought this change is in react-devtools you'll see the Hoverable being rendered twice because of isScrolling and isHovered.

hurali97 · 2023-09-26T08:46:43Z

src/components/Hoverable/index.js

-        this.checkHover = this.checkHover.bind(this);
+function InnerHoverable({disabled, onHoverIn, onHoverOut, children, shouldHandleScroll}, outerRef) {
+    const [isHovered, setIsHovered] = useState(false);
+    const [isScrolling, setIsScrolling] = useState(false);


I would suggest replacing isScrolling state in favour of isScrollingRef. Since using isScrolling state will re-render the Hoverable component and we can avoid it by using ref, which gives us a similar functionality but with less re-renders.

Got you @hurali97! I've implemented suggested changes 👍 Let's review it once again and we are good to go :)

hurali97

LGTM 🚀

Beamanator

Sorry for the delay!

Beamanator

Can we just add a comment here since useImperativeHandle isn't super well known AFAIK?

Then we can LGTM!

src/components/Hoverable/index.js

Beamanator

LGTM!

Beamanator · 2023-10-02T06:59:08Z

Seems jest unit test2 is failing, i'll retry and see if it passes

OSBotify · 2023-10-02T07:14:08Z

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

situchan · 2023-10-02T13:10:18Z

Regression from this PR:

Composer action menu, emoji pickers are broken

Screen.Recording.2023-10-02.at.7.09.24.PM.mov

MonilBhavsar · 2023-10-02T14:48:15Z

Regression: This PR seem to have introduced a critical bug where App crashes on pressing back button. @kacper-mikolajczak @ArekChr @Beamanator

https://expensify.slack.com/archives/C049HHMV9SM/p1696231998119979

kbecciv · 2023-10-02T17:12:22Z

Created the GH ticket #28634

OSBotify · 2023-10-02T17:46:43Z

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

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

OSBotify · 2023-10-03T15:47:40Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

OSBotify · 2023-10-03T16:12:03Z

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

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

OSBotify · 2023-10-05T00:18:53Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

kacper-mikolajczak changed the title ~~rewrite Hoverable class component into functional~~ Hoverable component refactored from class into functional approach Sep 12, 2023

gedu reviewed Sep 12, 2023

View reviewed changes

teneeto reviewed Sep 12, 2023

View reviewed changes

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

kacper-mikolajczak requested review from gedu and teneeto September 13, 2023 11:35

kacper-mikolajczak marked this pull request as ready for review September 13, 2023 12:30

kacper-mikolajczak requested a review from a team as a code owner September 13, 2023 12:30

melvin-bot bot removed request for a team, gedu and teneeto September 13, 2023 12:30

melvin-bot bot requested a review from ArekChr September 13, 2023 12:30

kacper-mikolajczak requested review from gedu and teneeto September 13, 2023 12:31

ArekChr reviewed Sep 15, 2023

View reviewed changes

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

ArekChr reviewed Sep 15, 2023

View reviewed changes

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

ArekChr suggested changes Sep 15, 2023

View reviewed changes

kacper-mikolajczak requested a review from ArekChr September 15, 2023 18:04

ArekChr approved these changes Sep 18, 2023

View reviewed changes

gedu approved these changes Sep 18, 2023

View reviewed changes

melvin-bot bot requested a review from Beamanator September 25, 2023 09:27

hurali97 suggested changes Sep 26, 2023

View reviewed changes

kacper-mikolajczak added 2 commits September 26, 2023 12:52

Fix scrollingListener cleanup

0dbb737

Replace isScrolling state with ref

d1c0a27

kacper-mikolajczak requested a review from hurali97 September 26, 2023 10:57

hurali97 approved these changes Sep 26, 2023

View reviewed changes

Beamanator approved these changes Sep 29, 2023

View reviewed changes

Beamanator requested changes Sep 29, 2023

View reviewed changes

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

add useImperativeHandle explanation comment

a9601db

kacper-mikolajczak requested a review from Beamanator September 29, 2023 09:21

Beamanator approved these changes Oct 2, 2023

View reviewed changes

Beamanator merged commit 2160bab into Expensify:main Oct 2, 2023
15 checks passed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

MonilBhavsar mentioned this pull request Oct 2, 2023

[HOLD for payment 2023-10-12] [HOLD for payment 2023-10-10] [$500] Web - App crash on click of back button #28634

Closed

6 tasks

mountiny mentioned this pull request Oct 2, 2023

[CP Staging] Revert "Hoverable component refactored from class into functional approach" #28642

Merged

58 tasks

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

Migrate index.js to function component #16161

Closed

1 task

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

kacper-mikolajczak mentioned this pull request Oct 7, 2023

Refactor Hoverable component into functional #29052

Merged

59 tasks

Hoverable component refactored from class into functional approach #27223

Hoverable component refactored from class into functional approach #27223

Conversation

kacper-mikolajczak commented Sep 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Sep 12, 2023 • edited Loading

kacper-mikolajczak commented Sep 12, 2023

kacper-mikolajczak commented Sep 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kacper-mikolajczak Sep 12, 2023 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

teneeto Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

teneeto commented Sep 12, 2023

melvin-bot bot commented Sep 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArekChr left a comment

Choose a reason for hiding this comment

ArekChr commented Sep 18, 2023

Reviewer Checklist

Screenshots/Videos

ArekChr left a comment

Choose a reason for hiding this comment

teneeto commented Sep 19, 2023

melvin-bot bot commented Sep 25, 2023

Beamanator commented Sep 26, 2023

hurali97 commented Sep 26, 2023

hurali97 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kacper-mikolajczak Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

hurali97 left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator commented Oct 2, 2023

OSBotify commented Oct 2, 2023

situchan commented Oct 2, 2023

MonilBhavsar commented Oct 2, 2023

kbecciv commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

kacper-mikolajczak commented Sep 12, 2023 •

edited

Loading

github-actions bot commented Sep 12, 2023 •

edited

Loading

kacper-mikolajczak Sep 12, 2023 •

edited

Loading

teneeto Sep 12, 2023 •

edited

Loading

kacper-mikolajczak Sep 26, 2023 •

edited

Loading