Remove multiple sources of tooltip size

[bernhardoj]

Details

We have a regression after fixing jittery effect here.

Fixed Issues

$ #18878
$ #17555
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Same as QA Steps

• Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web/Desktop

1. Create a group chat with many members if you don't have one
2. Open search page
3. Now find the group chat you created before
4. Hover over the three dots (ellipsis, ...) at the end of the member list name
5. Verify the tooltip text is aligned correctly above the arrow

Android/iOS/mWeb
Don't have tooltip

• 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-05-17.at.11.54.42.mov

Mobile Web - Chrome

No tooltip

Mobile Web - Safari

No tooltip

Desktop

Screen.Recording.2023-05-17.at.11.59.18.mov

iOS

No tooltip

Android

No tooltip

[melvin-bot]

@mollfpr @tgolen 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]

Additional video to test other cases:

Screen.Recording.2023-05-17.at.11.55.41.mov

[bernhardoj]

Here is the explanation of the issue:

The root cause of the issue is a wrong calculation of horizontal shift. Currently, we have 2 different state to store tooltip size, tooltipWidth/tooltipHeight (the initial wrapper width) and tooltipContentWidth (the text width).

Then, in getTooltipStyle we calculate wrapper width based on tooltipContentWidth to prevent the extra white space (can be seen from the image above) as mentioned in the comment.

App/src/styles/getTooltipStyles.js

Lines 136 to 139 in 811c0f3

	// We get wrapper width based on the tooltip's inner text width so the wrapper is just big enough to fit text and prevent white space.
	// If the text width is less than the maximum available width, add horizontal padding.
	// Note: tooltipContentWidth ignores the fractions (OffsetWidth) so add 1px to fit the text properly.
	const wrapperWidth = tooltipContentWidth && tooltipContentWidth + spacing.ph2.paddingHorizontal * 2 + 1;

Let say tooltipWidth is at its maximum, which is 375, and tooltipContentWidth is 350. This means, the tooltipWrapperStyle width will be smaller (and different) than tooltipWidth, which also means the value is not synchronized between the tooltipWidth state and the actual tooltip width. And because tooltipWidth is being used to calculate the horizontal shift, we get the wrong result. Previously, we don't have this issue because we use onLayout that will "synchronize" the value.

As we ultimately want to set the tooltip width based on it's content, we can just keep the state of the content width and height, then later on we calculate the tooltip wrapper size in getTooltipStyle. Also, as the tooltip width and height could be undefined, I set all the value that depends on the tooltip size with default value just like we did with wrapperTop/Left to prevent any potential error or warning.

[bernhardoj]

Oops, I think @mananjadhav and @amyevans should be the one to review this.

[mollfpr]

Bump @mananjadhav and un-assigning myself.

[tgolen]

Nice, thanks for those few changes.

[amyevans]

@bernhardoj There are conflicts now, please resolve when you get a chance 😄

[mananjadhav]

changes look good, can we please resolve the conflicts @bernhardoj? I can start testing then.

[bernhardoj]

Conflicts solved

[bernhardoj]

Because now we depends on isTooltipsizeReady to set the opacity (previously xOffset and yOffset), we can safely remove it because the tooltip won't be shown if useLayoutEffect hasn't done yet..

[mananjadhav]

Thanks, getting to this in next few mins.

[mananjadhav]

@bernhardoj Let's also link the original issue in Fixed Issues?

[bernhardoj]

Added 👍.

[mananjadhav]

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

Before

Fixed

Mobile Web - Chrome

NA

Mobile Web - Safari

NA

Desktop

iOS

NA

Android

NA

---

Thanks @bernhardoj for fixing this and patience here. @amyevans @tgolen All yours.

[OSBotify]

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

[bernhardoj]

@amyevans @mananjadhav I'm terribly sorry 🙇, but we have another regression only in Safari reported here where the text is truncated.

I found the problem is the width from getBoundingClientRect in Safari returns smaller value than Chromium. (actually, different browser returns different value, but only Safari that truncates the text)

Width from Emoji picker tooltip
Safari: 27.42300033569336
Chromium: 27.4296875
Firefox: 27.416671752929688

We previously use offsetWidth which does not include decimal value and add +1 to the width. Now we get the width from getBoundingClientRect hoping to get precise size of the tooltip, but looks like it's not possible for Safari.

Even offsetWidth is different between Chromium and Safari. Safari always rounds up width value from getBoundingClientRect as the offsetWidth while Chrome rounds up only if its > .5.

I'm thinking 2 options:

1. Use Math.ceil here to always round up the width
   

   App/src/styles/getTooltipStyles.js

   Lines 121 to 122 in 8180113

   	const tooltipWidth = tooltipContentWidth && tooltipContentWidth + spacing.ph2.paddingHorizontal * 2;
   	const tooltipHeight = tooltipContentHeight && tooltipContentHeight + tooltipVerticalPadding.paddingVertical * 2;

2. Add back + 1 to the tooltipWidth.

We don't need to change the height calculation. We just need to have extra width for Safari not truncating the text

Let me know if you agree and which one is preferable (I prefer the 2nd one to be very safe with Safari) and I will open another PR (we will test at least on Safari, Chrome, Firefox).

[OSBotify]

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

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

[bernhardoj]

@mananjadhav @amyevans Bump on this one #19097 (comment) before it becomes a deploy blocker.

[mananjadhav]

Thanks @bernhardoj for raising the PR. I tested the first PR on Safari but not the second one and we missed it. I've now tested on Chrome, Safari, Firefox and Edge.

[OSBotify]

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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