Refactor Hoverable component v2 #33257

kacper-mikolajczak · 2023-12-18T22:18:20Z

Details

PR introduces improved changes to Hoverable component.

It is a continuation of 32636 issue.

Fixed Issues

$ #32096
PROPOSAL: https://expensify.slack.com/archives/C05LX9D6E07/p1700572497547219

Tests

Open web app
Hover over LHN avatar elements. Tooltip should be displayed
In Composer, open actions and emoji boxes. The boxes should open over their parent button
Open Settings, go to Workspaces, go back and close sidebar. It should not crash
In devtools, toggle mobile device. It should not crash the app

Offline tests

Go offline
Open Settings, go to Workspaces, pick existing workspace
Open menu and delete workspace
It should properly display deleted workspace with striked-through text

QA Steps

Open web app
Hover over LHN avatar elements. Tooltip should be displayed
In Composer, open actions and emoji boxes. The boxes should open over their parent button
Open Settings, go to Workspaces, go back and close sidebar. It should not crash
In devtools, toggle mobile device. It should not crash the app

PR Author Checklist

Screenshots/Videos

Android: Native

mandroid.mp4

Android: mWeb Chrome

mandroid.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

mios.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

kacper-mikolajczak · 2023-12-19T12:47:20Z

seems like there are some typecheck errors.
But this PR was in Draft status.

Yup, there was some issues with TS while I was fixing other stuff. Thanks for pointing that out, it's been fixed already 👍

kacper-mikolajczak · 2023-12-19T12:57:09Z

Continuing the discussion held here, here is a brief explanation of what was improved:

Hoverable is now restricted to support only single child. The usage (there was one in OfflineWithFeedback) has been adjusted to follow that.
assignRef was replaced with mergeRefs, which resulted in simpler code
additional minor fixes were main while merging current main in order to avoid regressions (see details section of the PR description)

Having that said, I would highly appreciate to review the PR carefully with given QA steps.

@mountiny initial discussion and review of PR was done by @cubuspl42 and I think it might be valuable if we could assign the same reviewer for consistency. Thanks 👍

melvin-bot · 2023-12-19T13:44:38Z

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

src/libs/mergeRefs.ts

src/pages/home/report/ReportActionItem.js

cubuspl42 · 2023-12-20T11:55:18Z

Would you start PR threads on the places crucial for fixing the previously identified regressions?

Unless the commit structure separates bugfixes from the organisational changes, but I'm not sure if it does.

kacper-mikolajczak

Would you start PR threads on the places crucial for fixing the previously identified regressions?

Sure thing @cubuspl42! Here are the crucial places 👍

src/components/Tooltip/BaseTooltip/index.tsx

src/components/Hoverable/index.tsx

mountiny · 2023-12-26T16:19:59Z

@kacper-mikolajczak Seems like some unverified commits creeped in

github-actions · 2023-12-26T16:43:43Z

🧪🧪 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/33257/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/33257/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/33257/NewExpensify.dmg	https://33257.pr-testing.expensify.com

mountiny · 2023-12-26T16:57:48Z

@cubuspl42 Could you test on the build please?

cubuspl42 · 2023-12-27T08:42:17Z

I'm on it

cubuspl42 · 2023-12-27T10:34:10Z

@kacper-mikolajczak Please update the PR Author Checklist

src/components/Tooltip/BaseTooltip/index.tsx

kacper-mikolajczak · 2023-12-28T12:09:29Z

@kacper-mikolajczak Seems like some unverified commits creeped in

@mountiny Fixed 👍

kacper-mikolajczak · 2023-12-28T12:33:45Z

@kacper-mikolajczak Please update the PR Author Checklist

Generating dynamic checks...
/home/runner/work/App/App/.github/actions/javascript/authorChecklist/index.js:21[5](https://github.com/Expensify/App/actions/runs/7338235732/job/19980449424?pr=33257#step:3:6)[6](https://github.com/Expensify/App/actions/runs/7338235732/job/19980449424?pr=33257#step:3:7)8
    const [checklistContent, contentAfterChecklist] = contentAfterStartOfChecklist.split(checklistEndsWith);
                                                                                   ^

TypeError: Cannot read properties of undefined (reading 'split')
    at partitionWithChecklist (/home/runner/work/App/App/.github/actions/javascript/authorChecklist/index.js:21568:84)
    at generateDynamicChecksAndCheckForCompletion (/home/runner/work/App/App/.github/actions/javascript/authorChecklist/index.js:21598:[7](https://github.com/Expensify/App/actions/runs/7338235732/job/19980449424?pr=33257#step:3:8)0)

@cubuspl42 Are you familiar with this pipeline error?

This reverts commit 7b22bd9.

mountiny · 2024-01-04T14:17:41Z

Great progress on this, with discussion like this one it might be better to bring them to Slack though for faster resolution. Dont hesitate to do that.

Would be nice to wrap this one up sooner than later, great job done so far 🚀

cubuspl42 · 2024-01-04T14:50:18Z

Yeah, you're right. I have a habit of emptying my queue in iterations, but this one deserves a little more urgency. I'll give it a final round of testing and we should be good.

cubuspl42 · 2024-01-04T15:03:07Z

@kacper-mikolajczak Uhm, we've got some conflicts...

cubuspl42 · 2024-01-04T15:19:56Z

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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

hoverable-component-web.mov

MacOS: Desktop

hoverable-component-desktop.mov

cubuspl42

Please resolve the conflicts. I'll then do a final check to ensure the conflict resolution broke nothing, both otherwise we're good 👍

kacper-mikolajczak · 2024-01-08T09:16:01Z

@cubuspl42 conflicts resolved 👍

cubuspl42 · 2024-01-08T12:05:05Z

Could you take a look at the TypeScript Checks?

kacper-mikolajczak · 2024-01-08T12:14:19Z

On it! 🔧

kacper-mikolajczak · 2024-01-08T12:53:47Z

@cubuspl42 In order to fix typings, I needed to:

update some imports to type imports with import type syntax
in BaseTooltip, check if children is valid react element with isValidElement and in if yes, render Hoverable, and render primitve values (rest of ReactNode that could not be used with Hoverable as we cannot hook event callbacks to them, e.g. onMouseEnter) otherwise

mountiny

Quite complex changes but did not notice anything weird. Curious for @roryabraham thoughts too

roryabraham · 2024-01-09T02:42:41Z

Hey, just want to set expectations here that since this is just a refactor I'm not going to urgently prioritize reviewing this. I have a number of other more important things on my plate atm, so I don't expect to be able to review this until next week.

@mountiny if you're comfortable with the changes here, feel free to proceed without me

mountiny · 2024-01-09T13:44:31Z

Hey, just want to set expectations here that since this is just a refactor I'm not going to urgently prioritize reviewing this. I have a number of other more important things on my plate atm, so I don't expect to be able to review this until next week.

Thank you for this message, I think I would go ahead with merging this, as @cubuspl42 and @kacper-mikolajczak spent lots of time on testing all the issues previously identified

Thanks everyone!

OSBotify · 2024-01-09T13:49:42Z

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

perunt · 2024-01-09T16:03:52Z

src/components/Hoverable/index.tsx

+function Hoverable({isDisabled, ...props}: HoverableProps, ref: Ref<HTMLElement>) {
+    // If Hoverable is disabled, just render the child without additional logic or event listeners.
+    // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+    if (isDisabled || !hasHoverSupport()) {


A quick note: You've updated the prop from disabled to isDisabled in this component, but it seems that the corresponding changes haven't been made where this component is being used

App/src/pages/home/report/ReportActionItem.js

Line 675 in e8dc643

disabled={!_.isUndefined(props.draftMessage)}

Also, I see this error when hovering

due to this

App/src/components/Tooltip/BaseTooltip/index.tsx

Line 192 in 3895f80

children.props.onMouseEnter(e);

That's right, thanks for your feedback @perunt! ❤️

I didn't dig deeper into the influence of that bug, but it might have crashed due to the context menu on the draft message. Just bump @mountiny to keep it on the radar

Yeah, it looks like there was a mismatch between typing and actual usage. I've created a quickfix PR and notified @mountiny, thanks once again 👍

Thanks for the quick response ❤️

Merged, thank you ❤️

…component-refactor Quickfix: Hoverable refactor #33257

OSBotify · 2024-01-10T06:20:47Z

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

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

OSBotify · 2024-01-11T08:52:26Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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

kacper-mikolajczak added 7 commits December 18, 2023 23:08

bulk commit

c65ab55

hoverable v3 (3 commits ahead)

989e0df

merge main

dabf39c

merge main

9e2bb8a

remove nonexistent onMouseEnter usage

3ff7ed6

restrict Hoverable to receive single child only

28290c5

replace assignRef with mergeRefs

224e107

kacper-mikolajczak mentioned this pull request Dec 19, 2023

Hoverable refactor fixes #32636

Closed

47 tasks

kacper-mikolajczak marked this pull request as ready for review December 19, 2023 13:44

kacper-mikolajczak requested a review from a team as a code owner December 19, 2023 13:44

melvin-bot bot requested review from cubuspl42 and removed request for a team December 19, 2023 13:44

cubuspl42 suggested changes Dec 20, 2023

View reviewed changes

src/libs/mergeRefs.ts Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved

kacper-mikolajczak commented Dec 22, 2023

View reviewed changes

src/components/Tooltip/BaseTooltip/index.tsx Outdated Show resolved Hide resolved

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

mountiny assigned kacper-mikolajczak Dec 26, 2023

mountiny added the Ready To Build label Dec 26, 2023

cubuspl42 reviewed Dec 27, 2023

View reviewed changes

src/components/Tooltip/BaseTooltip/index.tsx Outdated Show resolved Hide resolved

kacper-mikolajczak added 2 commits December 27, 2023 12:56

remove link

c0c8a7e

fix OfflineWIthFeedback children & strikethrough

0af0d78

kacper-mikolajczak added 2 commits January 4, 2024 13:00

Revert "implement mapChildren helper"

441ebb5

This reverts commit 7b22bd9.

add mapChildrenFlat helper

ba7319c

cubuspl42 suggested changes Jan 4, 2024

View reviewed changes

merge main

9e834f2

fix typing and linting

c0a3e84

kacper-mikolajczak added 2 commits January 8, 2024 13:45

fix Tooltip children typings

116490e

fix TooltipProps child

b88474a

mountiny approved these changes Jan 9, 2024

View reviewed changes

mountiny merged commit bddf15d into Expensify:main Jan 9, 2024
15 checks passed

perunt reviewed Jan 9, 2024

View reviewed changes

kacper-mikolajczak added a commit to callstack-internal/Expensify-App that referenced this pull request Jan 9, 2024

fix Expensify#33257 issues

e751101

kacper-mikolajczak mentioned this pull request Jan 9, 2024

[NoQA] Quickfix: Hoverable refactor #33257 #34161

Merged

48 tasks

mountiny added a commit that referenced this pull request Jan 9, 2024

Merge pull request #34161 from callstack-internal/quickfix/hoverable-…

5df6055

…component-refactor Quickfix: Hoverable refactor #33257

github-actions bot mentioned this pull request Jan 10, 2024

Deploy Checklist: New Expensify 2024-01-10 #34203

Closed

54 tasks

melvin-bot bot mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-01-18] [HIGH] Clean up Hoverable component #32096

Closed

0xmiros mentioned this pull request Jan 17, 2024

[HOLD for payment 2024-02-07] [$1000] Chat - Hover color is not displayed even on move of cursor on changing windows and back #29077

Closed

6 tasks

situchan mentioned this pull request Jan 22, 2024

LOW: [$500] Unread notification in fevicon does not update when the user is in another tab #32225

Closed

6 tasks

Refactor Hoverable component v2 #33257

Refactor Hoverable component v2 #33257

Conversation

kacper-mikolajczak commented Dec 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kacper-mikolajczak commented Dec 19, 2023

kacper-mikolajczak commented Dec 19, 2023

melvin-bot bot commented Dec 19, 2023

cubuspl42 commented Dec 20, 2023 • edited Loading

kacper-mikolajczak left a comment

Choose a reason for hiding this comment

mountiny commented Dec 26, 2023

github-actions bot commented Dec 26, 2023

mountiny commented Dec 26, 2023

cubuspl42 commented Dec 27, 2023

cubuspl42 commented Dec 27, 2023

kacper-mikolajczak commented Dec 28, 2023 • edited Loading

kacper-mikolajczak commented Dec 28, 2023

mountiny commented Jan 4, 2024

cubuspl42 commented Jan 4, 2024

cubuspl42 commented Jan 4, 2024

cubuspl42 commented Jan 4, 2024

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

kacper-mikolajczak commented Jan 8, 2024

cubuspl42 commented Jan 8, 2024

kacper-mikolajczak commented Jan 8, 2024

kacper-mikolajczak commented Jan 8, 2024

mountiny left a comment

Choose a reason for hiding this comment

roryabraham commented Jan 9, 2024

mountiny commented Jan 9, 2024

OSBotify commented Jan 9, 2024

perunt Jan 9, 2024

Choose a reason for hiding this comment

perunt Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

perunt Jan 9, 2024

Choose a reason for hiding this comment

perunt Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

kacper-mikolajczak Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

perunt Jan 9, 2024

Choose a reason for hiding this comment

kacper-mikolajczak Jan 9, 2024

Choose a reason for hiding this comment

perunt Jan 9, 2024

Choose a reason for hiding this comment

mountiny Jan 9, 2024

Choose a reason for hiding this comment

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

kacper-mikolajczak commented Dec 18, 2023 •

edited

Loading

cubuspl42 commented Dec 20, 2023 •

edited

Loading

kacper-mikolajczak commented Dec 28, 2023 •

edited

Loading

perunt Jan 9, 2024 •

edited

Loading

perunt Jan 9, 2024 •

edited

Loading

kacper-mikolajczak Jan 9, 2024 •

edited

Loading