Tooltip functionality behaving weird for the copy to clipboard #17286

hasebsiddiqui · 2023-04-11T19:07:41Z

@tgolen @CortneyOfstad PR is ready for review.

Details

Tooltip functionality for the "copy to clipboard" feature in the "details" section behaves weird if clicked multiple times.

Fixed Issues

$ #17182
PROPOSAL: #17182 (comment)

Tests

Open any "chat".
Tap on name at header or display picture.
Select email by clicking “copy to clipboard”. Click it multiple times.

Verify that no errors appear in the JS console

Offline tests

Open any "chat".
Tap on name at header or display picture.
Select email by clicking “copy to clipboard”. Click it multiple times.

QA Steps

Open any "chat".
Tap on name at header or display picture.
Select email by clicking “copy to clipboard”. Click it multiple times.

Expected Result

The tooltip should work smoothly and not shake, even if the "copy to clipboard" feature is clicked multiple times.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-11.at.11.07.17.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-11.at.11.14.51.PM.mov

Mobile Web - Safari

Screen.Recording.2023-04-11.at.11.16.50.PM.mov

Desktop

Screen.Recording.2023-04-11.at.11.19.47.PM.mov

iOS

Screen.Recording.2023-04-12.at.12.01.40.AM.mov

Android

Screen.Recording.2023-04-11.at.11.54.04.PM.mov

MelvinBot · 2023-04-11T19:07:49Z

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

github-actions · 2023-04-11T19:08:01Z

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

thesahindia · 2023-04-11T19:09:15Z

It's EOD for me. I will review it tomorrow!

hasebsiddiqui · 2023-04-11T19:10:33Z

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

hasebsiddiqui · 2023-04-11T19:15:04Z

recheck

tgolen

I have not tested or gone through the checklist, but the code looks good! I'll leave the rest to @thesahindia.

thesahindia · 2023-04-12T11:59:51Z

Look like we got a little bit confused. The OG issue has nothing to do with multiple clicks (the post wasn't accurate). It can be easily reproduced by clicking one time, we just have to keep our cursor on the clipboard icon. BTW sometimes it works just fine.

Here's a slowed down vid of the issue-

Screen.Recording.2023-04-12.at.5.14.33.PM.mov

This is what we want-

Screen.Recording.2023-04-12.at.5.21.28.PM.mov

cc: @hasebsiddiqui

hasebsiddiqui · 2023-04-12T12:30:24Z

I understand your point now, but the main focus of the issue was on multiple clicks. And there was also the issue of the label returning back to its previous state i.e. "Copy to clipboard" in case of multiple clicks. So my proposal and the PR effort were spent on fixing that.

thesahindia · 2023-04-12T17:17:01Z

Yeah it was confusing I was confused myself. Do you have a fix for the above issue?

hasebsiddiqui · 2023-04-12T18:32:07Z

@thesahindia No I don't have fix for above issue. But I think I should be paid for this one because I managed to provide the solution according to the issue statement. If not for this issue then may be create an other issue for multiple clicks problem and assign this PR to that issue?

thesahindia · 2023-04-13T11:18:36Z

@tgolen, how should we proceed?
Please check #17286 (comment) for context.

tgolen · 2023-04-13T12:58:35Z

I'd personally like to see if @hasebsiddiqui would try fixing both issues in this PR. I know it's a slight increase of scope from what was agreed upon in the issue, but the additional problem only surfaced once the PR was written. The new problem is so closely related that I think fixing it in this PR would be ideal.

IF @hasebsiddiqui finds out that the root cause of this new problem is significantly difficult to fix and will take significantly more time to fix, then I think we can either:

Increase compensation on the current issue
Open a new issue

hasebsiddiqui · 2023-04-13T14:03:30Z

I have already found the cause of the problem. The problem is in TooltipRenderedOnPageBody component which is subcomponent of Tooltip component. So this problem should be reproducible anywhere where Tooltip inner content is changing, not only on just "details" screen.
Problem lies in componentDidUpdate function. Here the tooltipContentWidth is set to undefined on every component update. Due to this an additional rendered is performed on tooltip which is causing issues. As seen in the video.

componentDidUpdate(prevProps) {
    if (
      prevProps.text === this.props.text &&
      prevProps.renderTooltipContent === this.props.renderTooltipContent
    ) {
      return;
    }

    // Reset the tooltip text width to 0 so that we can measure it again.
    // eslint-disable-next-line react/no-did-update-set-state
    this.setState(
      {tooltipContentWidth: undefined},
      this.updateTooltipContentWidth,
    );
  }

Video:

Screen.Recording.2023-04-13.at.6.15.29.PM.mov

If I comment the last line in this function that sets tooltipContentWidth to undefined then the tooltip behaves correctly but the width of the tooltip is not calculated correctly:
Video:

Screen.Recording.2023-04-13.at.6.16.20.PM.mov

I am unable to figure out how to calculate width for tooltip correctly without setting tooltipContentWidth to undefined.

So, I believe this requires significant more effort in solving than the original scope. Also since the issue is in Tooltip component instead of the "details" section so it will require a lot more testing after fixing to check tooltip behaves correctly everywhere in app. Although I managed to find the source of problem but I am unable to fix it. So I would prefer to create a new issue for this. Thanks.
CC: @tgolen

tgolen · 2023-04-13T14:08:46Z

OK, thank you for investigating it. I agree with you that this seems like having a new GH issue opened for it would be a good idea.

hasebsiddiqui · 2023-04-13T17:01:50Z

@thesahindia Let me know if there is anything remaining from my side to get this PR merged. Thanks.

thesahindia · 2023-04-13T22:40:34Z

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

Screen.Recording.2023-04-14.at.4.00.24.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-14.at.3.58.08.AM.mov

Mobile Web - Safari

Screen.Recording.2023-04-14.at.3.53.58.AM.mov

Desktop

Screen.Recording.2023-04-14.at.4.02.48.AM.mov

iOS

Screen.Recording.2023-04-14.at.3.52.19.AM.mov

Android

Screen.Recording.2023-04-14.at.3.56.21.AM.mov

thesahindia · 2023-04-13T22:43:01Z

@tgolen, please re-run the checks.

tgolen · 2023-04-14T13:06:59Z

OK, we are all good here. Gonna merge it.

tgolen · 2023-04-14T13:07:25Z

Can one of you please be sure to report the other bug that was found?

OSBotify · 2023-04-14T13:12:35Z

✋ 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 · 2023-04-18T04:39:57Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-18T06:09:33Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-19T17:22:42Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀

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

Tooltip functionality for the copy to clipboard

b8d3536

hasebsiddiqui requested a review from a team as a code owner April 11, 2023 19:07

melvin-bot bot requested review from tgolen and thesahindia and removed request for a team April 11, 2023 19:07

tgolen approved these changes Apr 11, 2023

View reviewed changes

thesahindia approved these changes Apr 13, 2023

View reviewed changes

tgolen merged commit 1138093 into Expensify:main Apr 14, 2023

OSBotify mentioned this pull request Apr 17, 2023

Deploy Checklist: New Expensify 2023-04-17 #17546

Closed

53 tasks

MelvinBot mentioned this pull request Apr 19, 2023

[HOLD for payment 2023-04-26] [$1000] Tooltip functionality for the "copy to clipboard" feature in the "details" section behaves weird if clicked multiple times. #17182

Closed

6 tasks

sobitneupane mentioned this pull request May 5, 2023

fix inconsistent behavior on toggle button delay #18466

Merged

57 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tooltip functionality behaving weird for the copy to clipboard #17286

Tooltip functionality behaving weird for the copy to clipboard #17286

hasebsiddiqui commented Apr 11, 2023

MelvinBot commented Apr 11, 2023

github-actions bot commented Apr 11, 2023 •

edited

Loading

thesahindia commented Apr 11, 2023

hasebsiddiqui commented Apr 11, 2023

hasebsiddiqui commented Apr 11, 2023

tgolen left a comment

thesahindia commented Apr 12, 2023 •

edited

Loading

hasebsiddiqui commented Apr 12, 2023

thesahindia commented Apr 12, 2023

hasebsiddiqui commented Apr 12, 2023 •

edited

Loading

thesahindia commented Apr 13, 2023

tgolen commented Apr 13, 2023

hasebsiddiqui commented Apr 13, 2023

tgolen commented Apr 13, 2023

hasebsiddiqui commented Apr 13, 2023

thesahindia commented Apr 13, 2023

thesahindia commented Apr 13, 2023

tgolen commented Apr 14, 2023

tgolen commented Apr 14, 2023

OSBotify commented Apr 14, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

Tooltip functionality behaving weird for the copy to clipboard #17286

Tooltip functionality behaving weird for the copy to clipboard #17286

Conversation

hasebsiddiqui commented Apr 11, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

Expected Result

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 11, 2023

github-actions bot commented Apr 11, 2023 • edited Loading

thesahindia commented Apr 11, 2023

hasebsiddiqui commented Apr 11, 2023

hasebsiddiqui commented Apr 11, 2023

tgolen left a comment

Choose a reason for hiding this comment

thesahindia commented Apr 12, 2023 • edited Loading

hasebsiddiqui commented Apr 12, 2023

thesahindia commented Apr 12, 2023

hasebsiddiqui commented Apr 12, 2023 • edited Loading

thesahindia commented Apr 13, 2023

tgolen commented Apr 13, 2023

hasebsiddiqui commented Apr 13, 2023

tgolen commented Apr 13, 2023

hasebsiddiqui commented Apr 13, 2023

thesahindia commented Apr 13, 2023

Reviewer Checklist

Screenshots/Videos

thesahindia commented Apr 13, 2023

tgolen commented Apr 14, 2023

tgolen commented Apr 14, 2023

OSBotify commented Apr 14, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

github-actions bot commented Apr 11, 2023 •

edited

Loading

thesahindia commented Apr 12, 2023 •

edited

Loading

hasebsiddiqui commented Apr 12, 2023 •

edited

Loading