Fix Email tooltip of the user avatar in the chat report page is incorrectly positioned #16370

hoangzinh · 2023-03-21T22:52:23Z

Details

Fixed Issues

$ #15586
PROPOSAL: #15586 (comment)

Tests

Before we jump into steps, just wanna ensure we're on same page:
a report item is a chat message

On web or desktop, open any chat report that has more than a page worth of messages.
Hover over the user avatar of a report item at the bottom of page, verify that the Email tooltip is displaying at top position of user avatar
Hover over the user avatar of a report item at the middle of page, verify that the Email tooltip is displaying at top position of user avatar
Scroll until the user avatar of any of the report item is partially behind the report header.
Hover over the user avatar of report item at that instance, verify that the Email tooltip is displaying at bottom position of user avatar
Repeat 2->5 for Emoji reactions of a report item
Repeat 2->5 for Hover menu's items of a report item

Verify that no errors appear in the JS console

Offline tests

This feature doesn't change or is impacted by offline mode.

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-03-22.at.06.21.30-1080.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-03-22.at.06.35.23-1080.mp4

iOS

Android

github-actions · 2023-03-21T22:52:40Z

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

hoangzinh · 2023-03-21T22:55:02Z

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

hoangzinh · 2023-03-21T23:14:57Z

recheck

MelvinBot · 2023-03-22T02:54:41Z

@yuwenmemon @aimane-chnaif 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]

aimane-chnaif · 2023-03-22T04:37:17Z

src/styles/getTooltipStyles.js

@@ -58,6 +58,10 @@ function computeHorizontalShift(windowWidth, xOffset, componentWidth, tooltipWid
 * @returns {Boolean}
 */
 function isOverlappingAtTop(xOffset, yOffset) {
+    if (typeof document.elementFromPoint !== 'function') {


ensure it won't raise error on unsupported browser

@hoangzinh which browser doesn't support this?

my bad without check this one. 99.1% supported browser is a high number. According to screenshot above, some very old browsers don't support it, but small percent.

btw, do you mean from this comment is we need to check document.elementFromPoint is exist before use?

I actually meant this check which you already did:

const element = document.elementFromPoint(xOffset, yOffset); if (!element) { return false; }

Not elementFromPoint function itself

btw, let's leave as it is now

src/styles/getTooltipStyles.js

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

aimane-chnaif · 2023-03-22T07:10:59Z

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 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 correct English and 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 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.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

aimane-chnaif

Looks good and tests well 🎉

@hoangzinh Excellent work on your first job!

All yours @yuwenmemon

yuwenmemon · 2023-03-22T17:15:44Z

src/styles/getTooltipStyles.js

+    }
+
+    const element = document.elementFromPoint(xOffset, yOffset);
+


Nab: uneccessary blank space

OSBotify · 2023-03-22T17:30:56Z

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

hoangzinh · 2023-03-22T21:49:09Z

Thank you so much for reviewing this PR @aimane-chnaif @yuwenmemon

yuwenmemon · 2023-03-23T19:19:45Z

Of course @hoangzinh! Thanks for making Expensify a little bit better! ❤️

OSBotify · 2023-03-24T19:06:38Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.2.89-0 🚀

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

OSBotify · 2023-03-27T10:33:20Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

fedirjh · 2023-07-20T20:10:16Z

src/styles/getTooltipStyles.js

    // we'll display it beneath its wrapped component rather than above it as usual.
-    const shouldShowBelow = (yOffset - tooltipHeight) < GUTTER_WIDTH;
+    const shouldShowBelow = (yOffset - tooltipHeight) < GUTTER_WIDTH || isOverlappingAtTop(xOffset, yOffset);


This line introduced an edge case regression in #17844 , more context here #17844 (comment)

hoangzinh added 2 commits March 22, 2023 05:18

determine if there is an overlapping element at top

b4ade6e

ensure it won't raise error on unsupported browser

aef1196

Ensure it won't raise error if element not found

107c607

hoangzinh marked this pull request as ready for review March 22, 2023 02:54

hoangzinh requested a review from a team as a code owner March 22, 2023 02:54

melvin-bot bot requested review from aimane-chnaif and yuwenmemon and removed request for a team March 22, 2023 02:54

update comment

6ba71ec

aimane-chnaif suggested changes Mar 22, 2023

View reviewed changes

Update function description from code review

eac6c73

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

aimane-chnaif approved these changes Mar 22, 2023

View reviewed changes

yuwenmemon approved these changes Mar 22, 2023

View reviewed changes

yuwenmemon merged commit 2bd8b48 into Expensify:main Mar 22, 2023

hoangzinh deleted the df/15586 branch March 24, 2023 00:01

OSBotify mentioned this pull request Mar 24, 2023

Deploy Checklist: New Expensify 2023-03-24 #16489

Closed

44 tasks

MelvinBot mentioned this pull request Mar 27, 2023

[HOLD for payment 2023-04-03] [$2000] Email tooltip of the user avatar in the chat report page is incorrectly positioned. #15586

Closed

6 tasks

alitoshmatov mentioned this pull request Apr 25, 2023

[HOLD for payment 2023-07-20] [$1000] The tooltip changes its position when changed the language preference and works well after refreshing the page #17844

Closed

6 tasks

bernhardoj mentioned this pull request May 1, 2023

refactor tooltip to fix double focusable component #16052

Merged

55 tasks

fedirjh reviewed Jul 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Email tooltip of the user avatar in the chat report page is incorrectly positioned #16370

Fix Email tooltip of the user avatar in the chat report page is incorrectly positioned #16370

hoangzinh commented Mar 21, 2023 •

edited

Loading

github-actions bot commented Mar 21, 2023 •

edited

Loading

hoangzinh commented Mar 21, 2023

hoangzinh commented Mar 21, 2023

MelvinBot commented Mar 22, 2023

aimane-chnaif Mar 22, 2023

hoangzinh Mar 22, 2023

aimane-chnaif Mar 22, 2023

aimane-chnaif Mar 22, 2023

aimane-chnaif commented Mar 22, 2023

aimane-chnaif left a comment

yuwenmemon Mar 22, 2023

OSBotify commented Mar 22, 2023

hoangzinh commented Mar 22, 2023

yuwenmemon commented Mar 23, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

fedirjh Jul 20, 2023

		}

		const element = document.elementFromPoint(xOffset, yOffset);

Fix Email tooltip of the user avatar in the chat report page is incorrectly positioned #16370

Fix Email tooltip of the user avatar in the chat report page is incorrectly positioned #16370

Conversation

hoangzinh commented Mar 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Mar 21, 2023 • edited Loading

hoangzinh commented Mar 21, 2023

hoangzinh commented Mar 21, 2023

MelvinBot commented Mar 22, 2023

aimane-chnaif Mar 22, 2023

Choose a reason for hiding this comment

hoangzinh Mar 22, 2023

Choose a reason for hiding this comment

aimane-chnaif Mar 22, 2023

Choose a reason for hiding this comment

aimane-chnaif Mar 22, 2023

Choose a reason for hiding this comment

aimane-chnaif commented Mar 22, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

yuwenmemon Mar 22, 2023

Choose a reason for hiding this comment

OSBotify commented Mar 22, 2023

hoangzinh commented Mar 22, 2023

yuwenmemon commented Mar 23, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

fedirjh Jul 20, 2023

Choose a reason for hiding this comment

hoangzinh commented Mar 21, 2023 •

edited

Loading

github-actions bot commented Mar 21, 2023 •

edited

Loading