Fix tooltip doesn't show after closing the emoji picker

[bernhardoj]

Details

Fixed Issues

$ #33683
$ #31155
PROPOSAL:

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. Open status page (Settings > Profile > Status)
2. Hover over the emoji picker button
3. Verify a tooltip is shown
4. Press the emoji picker button
5. Verify the tooltip is hidden
6. Press again to close the emoji picker
7. Verify the tooltip is shown back

Web/Desktop

1. Open any chat
2. Open the emoji picker
3. Resize the browser/desktop window to small and back to large
4. Verify the emoji picker position is still shown on top of the emoji picker button

Android/iOS/mWeb
No 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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-12-28.at.13.41.40.mov

Screen.Recording.2024-01-17.at.11.38.44.mov

MacOS: Desktop

Screen.Recording.2023-12-28.at.13.42.04.mov

Screen.Recording.2024-01-17.at.11.37.14.mov

[melvin-bot]

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

[bernhardoj]

@aimane-chnaif @neil-marcellini Our emoji picker PR caused this issue #33683.

Explanation of the issue:
The tooltip uses PopoverAnchorTooltip that will hide the tooltip if the popover is currently showing. However, even after the popover is closed, the popover isOpen state is still true, so the tooltip stays hidden.

App/src/components/Tooltip/PopoverAnchorTooltip.tsx

Lines 11 to 23 in 573f6b7

	const isPopoverRelatedToTooltipOpen = useMemo(() => {
	// eslint-disable-next-line @typescript-eslint/dot-notation
	const tooltipNode = tooltipRef.current?.['_childNode'] ?? null;
	if (isOpen && popover?.anchorRef?.current && tooltipNode && (tooltipNode.contains(popover.anchorRef.current) || tooltipNode === popover.anchorRef.current)) {
	return true;
	}
	return false;
	}, [isOpen, popover]);
	if (!shouldRender || isPopoverRelatedToTooltipOpen) {
	return children;
	}

The reason is that, when we close the popover, the anchorRef object reference is not the same as the activePopoverRef.current.anchorRef object reference, so we return early. (notice it uses !== to compare the reference)

App/src/components/PopoverProvider/index.tsx

Lines 15 to 26 in 573f6b7

	const closePopover = React.useCallback((anchorRef?: React.RefObject<HTMLElement>) => {
	if (!activePopoverRef.current || (anchorRef && anchorRef !== activePopoverRef.current.anchorRef)) {
	return;
	}
	activePopoverRef.current.close();
	if (activePopoverRef.current.onCloseCallback) {
	activePopoverRef.current.onCloseCallback();
	}
	activePopoverRef.current = null;
	setIsOpen(false);
	}, []);

Why is it different?
getEmojiPopoverAnchor will return either the local ref or the ref of the element (the button).

App/src/components/EmojiPicker/EmojiPicker.js

Line 47 in 573f6b7

const getEmojiPopoverAnchor = useCallback(() => emojiPopoverAnchorRef.current || emojiPopoverAnchorRef, []);

When we show the emoji picker, the popover provider will store the ref of the element.

When we try to close the emoji picker, we immediately clear the ref, so getEmojiPopoverAnchor will return the local ref now.

App/src/components/EmojiPicker/EmojiPicker.js

Lines 85 to 91 in 573f6b7

	const hideEmojiPicker = (isNavigating) => {
	if (isNavigating) {
	onModalHide.current = () => {};
	}
	emojiPopoverAnchorRef.current = null;
	setIsEmojiPickerVisible(false);
	};

And because of that, PopoverWithoutOverlay will call closePopover/close with the local ref.

App/src/components/PopoverWithoutOverlay/index.tsx

Lines 55 to 59 in 573f6b7

	} else {
	onModalHide();
	close(anchorRef);
	Modal.onModalDidClose();
	}

So, local ref object !== emoji picker button ref object.

I think we can consider this one as not a regression, but rather discovering a hidden bug. The real issue here is that we pass a different ref to closePopover. This doesn't happen before because we compare the ref object reference, but still in the previous code, we have a different ref value.

In the previous code, when we show the emoji picker, the popover will store the ref as:
{current: buttonElement}

And when we close the emoji picker, we pass {current: null} to closePopover.

Notice the ref value is already different, but it still works because the object reference is the same.

The solution is to avoid the ref being updated before the popover is completely hidden.

[shubham1206agra]

@bernhardoj There's seems to be a problem with your approach

Current

Screen.Recording.2023-12-30.at.11.15.24.AM.mov

This PR

Screen.Recording.2023-12-30.at.11.13.39.AM.mov

Mine approach in #33683 (comment)

Screen.Recording.2023-12-30.at.11.17.18.AM.mov

This approach (i.e., the current logic for hiding the modal) was added to #7580.

cc @aimane-chnaif @neil-marcellini

[shubham1206agra]

I think we can consider this one as not a regression, but rather discovering a hidden bug.

I strongly believe this is a regression, but its a easy to miss bug as you are not testing this behavior at all in the first place. (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)

[bernhardoj]

Thanks for catching that. I didn't realize onModalHide will be called when the popover changes from PopoverWithoutOverlay to Modal.

I have pushed a new fix (which is still based on my previous fix because it fixes the root cause of the issue).

[shubham1206agra]

@bernhardoj I believe you need to fix reassure test too

[bernhardoj]

@shubham1206agra it fails on main too

[aimane-chnaif]

@bernhardoj please also check if #33873 came from our PR. If so, let's fix it here.

[bernhardoj]

Checking

[bernhardoj]

I don't know how long the delay in #33873, but did feel the delay a little bit (~ 1s), so I tried switching my branch to the previous PR branch and the delay is gone, so the issue is not from our PR.

I reverting one by one commits and the delay is gone when reverting this one #32551.

[aimane-chnaif]

Please also check if this performance regression came from our PR.
As you see video, label floating animation is very laggy

Screen.Recording.2024-01-04.at.11.58.38.AM.mov

[bernhardoj]

Unrelated, already happens before the PR.

[bernhardoj]

@aimane-chnaif don't forget to check this one

[aimane-chnaif]

I got crash while following Test step.
While picker modal is open, switch to another tab and then back

[bernhardoj]

Thanks for catching that. I think I forgot to restest it after addressing this issue.

The onModalHide here is undefined

App/src/components/EmojiPicker/EmojiPickerButtonDropdown.js

Line 39 in 6a6b5fc

EmojiPickerAction.showEmojiPicker(props.onModalHide, (emoji) => props.onInputChange(emoji), emojiPopoverAnchor, {

We can have a default props for it, but to be very safe, I think it's better to check whether the hide callback is not undefined before calling it.

[aimane-chnaif]

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

Screen.Recording.2024-01-15.at.4.28.19.PM.mov

MacOS: Desktop

[neil-marcellini]

Looks good. Can we also included tests and QA for resizing, and upload a video of that before merging?

[bernhardoj]

@neil-marcellini added

[neil-marcellini]

Great thanks!

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

[OSBotify]

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.4.27-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.27-1 🚀

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