Migrate TooltipRenderedOnPageBody and fix tooltip flicker/moving when the content changes #18189

bernhardoj · 2023-04-29T10:39:08Z

Details

The main goal of the PR is to fix the flickering of the tooltip when the content changes. To achieve it, we need to use useLayoutEffect which is only available on functional component, thus the migration is also done here.

Fixed Issues

$ #17555
PROPOSAL: #17555 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Android/iOS/mWeb
No tooltip on these platforms

Web/Desktop

Open any chat
Click on their profile image
Hover over the Copy icon next to the user email/phone number
Verify a tooltip shows with a text "Copy to clipboard"
Click the Copy icon
Verify the tooltip text changes to "Copied"
Wait for a while and verify the text changes back to "Copy to clipboard"
Repeat 5-7
Verify the tooltip does not flicker/moving when the text changes

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

Screen.Recording.2023-04-29.at.18.19.16.mov

Mobile Web - Chrome

No Tooltip

Mobile Web - Safari

No Tooltip

Desktop

Screen.Recording.2023-04-29.at.18.24.10.mov

iOS

No Tooltip

Android

No Tooltip

MelvinBot · 2023-04-29T10:39:15Z

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

bernhardoj · 2023-04-29T11:13:39Z

Turns out there are more changes than expected. Here is the explanation of the changes:

To prevent the tooltip flickering/moving, we use useLayoutEffect and remove onLayout, which means we need to migrate the component to functional.

Besides migrating it, there are also some logic changes to the component, mainly the tooltipContentWidth and the getTooltipStyles.

Before:
tooltipContentWidth is used to calculate the tooltip width. If it's bigger then props.maxWidth, we use props.maxWidth. If the text changes, we set tooltipContentWidth to undefined so the tooltip width will also be undefined which means it will take as wide as it can and then recalculate the position.

Now:
To correctly calculate the tooltip position, all value will be in it's default state.
tooltipWidth, tooltipHeight, left, top -> 0
tooltipContentWidth -> undefined
scale -> 1
maxWidth will always be set to 375

(because we set all value initially to their "default", we don't need this workaround anymore that fixed this issue)
When the useLayoutEffect runs, we get the width and height of the tooltip and it's content, then show the tooltip to the user with the correct style. (actually the same step explained in the doc). Now, the most different thing is when the text changes. Previously, when the text changes, we set tooltipContentWidth back to undefined to calculate the new position. However, this is slow because there are multiple render happens.

text changes -> rerender -> update tooltipContentWidth to undefined -> rerender -> calculate new position -> rerender

In order to solve it, I use key with the key of this.props.text so whenever the text changes TooltipRenderedOnPageBody will completely remount with a fresh state which will prevent the flickering/moving.

Last thing, I just realized that tooltip with custom component content could also changes, for example the reaction tooltip (the only custom tooltip). Here is a recording on main branch showing the reaction tooltip flickers.

Screen.Recording.2023-04-29.at.16.56.41.mov

So, to solve it, I introduce a new props called renderTooltipContentKey to allow the custom tooltip to pass what key that if changes could resize it's content and added it as a key along with this.props.text.

In short, we follow the same step as mentioned in the doc). When the text changes, we remount the component which will repeat the exact steps from the doc

It's quite hard to explain it all with words, so please ask if there is anything confusing 😄.

bernhardoj · 2023-04-29T11:14:50Z

Here is additional video to show the tooltip still works fine on other components:

Screen.Recording.2023-04-29.at.18.20.03.mov

===

Btw, I notice that currently (on prod), the tooltip won't move if the wrapped component width increase/decrease. If we care about that, I think we can create a new issue to investigate it (it's because the wrapped component width is not updated, but I guess it needs quite a lot changes too, so I leave it as it is)

Screen.Recording.2023-04-29.at.19.04.37.mov

mananjadhav · 2023-05-04T17:20:33Z

@bernhardoj I understood the changes and thanks for updating this, turned out really well. I am just a bit concerned about the type here renderTooltipContentKey: PropTypes.arrayOf(PropTypes.any), and I'll leave that for @amyevans to decide.

Testing now.

mananjadhav · 2023-05-04T18:21:31Z

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 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-tooltip-func.mov

web-safari-tooltip-func_pz9Vx3zR.mp4

Mobile Web - Chrome

-NA-

Mobile Web - Safari

-NA-

Desktop

desktop-tooltip-func.mov

iOS

-NA-

Android

-NA-

----

Thanks for the patience here @bernhardoj. I had to test this on Web Chrome and Safari both and Desktop. @amyevans All yours.

bernhardoj · 2023-05-05T07:33:32Z

@mananjadhav thanks for the review.

concerned about the type here renderTooltipContentKey: PropTypes.arrayOf(PropTypes.any)

Hmm yeah, maybe we can make it specific to one of string, number, or bool?

renderTooltipContentKey: PropTypes.arrayOf(PropTypes.oneOfType([
    PropTypes.number,
    PropTypes.string,
    PropTypes.bool,
])),

From my testing, key won't work if the type is an object.

amyevans

Looking good!

src/components/Tooltip/TooltipRenderedOnPageBody.js

src/components/Tooltip/tooltipPropTypes.js

src/components/Tooltip/TooltipRenderedOnPageBody.js

amyevans · 2023-05-08T16:44:35Z

Manan is offline and previously approved, so I'm going to proceed and merge!

OSBotify · 2023-05-09T03:31:56Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.12-0 🚀

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

OSBotify · 2023-05-09T04:03:55Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

OSBotify · 2023-05-09T04:05:15Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.12-0 🚀

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

fedirjh · 2023-07-14T17:27:14Z

src/components/Tooltip/index.js

+
+                        // We pass a key, so whenever the content changes this component will completely remount with a fresh state.
+                        // This prevents flickering/moving while remaining performant.
+                        key={[this.props.text, ...this.props.renderTooltipContentKey]}


This line caused a regression in #19693 , Using a key will trigger the view to re-render when the text changes. However, if the text changes before the animation finishes, it will cancel the animation, and the tooltip will disappear. More context

jjcoffee · 2024-10-08T09:03:15Z

src/components/Tooltip/TooltipRenderedOnPageBody.js

+    }, [props.text, props.renderTooltipContent]);
+
+    useLayoutEffect(() => {
+        // Calculate the tooltip width and height before the browser repaints the screen to prevent flicker


Coming from #48691, we had an issue where the tooltip displays as blank. This happens because the tooltip component gets frozen when navigating several screens away and then back and when this effect is called a second time, the size is calculated as 0 due to the animation effect scale(0). More details here.

bernhardoj added 3 commits April 29, 2023 18:16

add tooltip text as the key

a6f3833

add renderTooltipContentKey as additional key of tooltip

7628b19

migrate to functional component and fix flicker when content changes

a467937

bernhardoj requested a review from a team as a code owner April 29, 2023 10:39

melvin-bot bot requested review from amyevans and mananjadhav and removed request for a team April 29, 2023 10:39

bernhardoj mentioned this pull request May 1, 2023

refactor tooltip to fix double focusable component #16052

Merged

55 tasks

mananjadhav previously approved these changes May 4, 2023

View reviewed changes

amyevans reviewed May 8, 2023

View reviewed changes

src/components/Tooltip/TooltipRenderedOnPageBody.js Outdated Show resolved Hide resolved

src/components/Tooltip/tooltipPropTypes.js Outdated Show resolved Hide resolved

src/components/Tooltip/TooltipRenderedOnPageBody.js Show resolved Hide resolved

bernhardoj added 4 commits May 9, 2023 00:08

Merge branch 'main' into fix/17555

be791fd

update comment

9ba08a4

update proptypes to be more specific

8cdba0e

add comment

ec87028

bernhardoj dismissed mananjadhav’s stale review via ec87028 May 8, 2023 16:29

amyevans approved these changes May 8, 2023

View reviewed changes

amyevans merged commit 4ef30e8 into Expensify:main May 8, 2023

OSBotify mentioned this pull request May 9, 2023

Deploy Checklist: New Expensify 2023-05-09 #18627

Closed

26 tasks

melvin-bot bot mentioned this pull request May 9, 2023

[HOLD for payment 2023-06-30] [$1000] Jittery transition of tooltip when the inner content changes #17555

Closed

6 tasks

hoangzinh mentioned this pull request May 13, 2023

[HOLD for payment 2023-06-01] [Regression Hold] The tooltip is not aligned with the arrow if the arrow position is at right edge of the tooltip. #18878

Closed

6 tasks

BeeMargarida mentioned this pull request Jun 30, 2023

[HOLD for payment 2023-07-14] [$1000] The tooltip disappears when the "Copy to clipboard" option is clicked multiple times. #19693

Closed

6 tasks

fedirjh reviewed Jul 14, 2023

View reviewed changes

tienifr mentioned this pull request Apr 22, 2024

Feature: Tooltip for QAB #40066

Merged

50 tasks

QichenZhu mentioned this pull request Sep 12, 2024

[$250] Web - LHN - Blank tooltip displayed when created a workspace and hover over workspace selector #48691

Open

6 tasks

jjcoffee reviewed Oct 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate TooltipRenderedOnPageBody and fix tooltip flicker/moving when the content changes #18189

Migrate TooltipRenderedOnPageBody and fix tooltip flicker/moving when the content changes #18189

bernhardoj commented Apr 29, 2023

MelvinBot commented Apr 29, 2023

bernhardoj commented Apr 29, 2023 •

edited

Loading

bernhardoj commented Apr 29, 2023

mananjadhav commented May 4, 2023

mananjadhav commented May 4, 2023

bernhardoj commented May 5, 2023

amyevans left a comment

amyevans commented May 8, 2023

OSBotify commented May 9, 2023

OSBotify commented May 9, 2023

OSBotify commented May 9, 2023

fedirjh Jul 14, 2023

jjcoffee Oct 8, 2024

Migrate TooltipRenderedOnPageBody and fix tooltip flicker/moving when the content changes #18189

Migrate TooltipRenderedOnPageBody and fix tooltip flicker/moving when the content changes #18189

Conversation

bernhardoj commented Apr 29, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 29, 2023

bernhardoj commented Apr 29, 2023 • edited Loading

bernhardoj commented Apr 29, 2023

mananjadhav commented May 4, 2023

mananjadhav commented May 4, 2023

Reviewer Checklist

Screenshots/Videos

bernhardoj commented May 5, 2023

amyevans left a comment

Choose a reason for hiding this comment

amyevans commented May 8, 2023

OSBotify commented May 9, 2023

OSBotify commented May 9, 2023

OSBotify commented May 9, 2023

fedirjh Jul 14, 2023

Choose a reason for hiding this comment

jjcoffee Oct 8, 2024

Choose a reason for hiding this comment

bernhardoj commented Apr 29, 2023 •

edited

Loading