[HOLD for payment 2023-10-30] [$500] Copy to clipboard tooltip moves to top left corner on copy to clipboard click

[kbecciv]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 1.3.84.4
Reproducible in staging?: y
Reproducible in production?: n
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1697387056991069

Action Performed:

1. Open the app
2. Open any report
3. Click on self profile pic or any user profile pic
4. Hover first on email/phone number and then hover and click on 'copy to clipboard'
5. Do not move the cursor and observe that tooltip shifts to top left corner of screen

Expected Result:

App should display tooltip above copy to clipboard after click on it

Actual Result:

App displays tooltip in top left corner after click on copy to clipboard

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

windows.chrome.copy.to.clipboard.tooltip.displays.top.left.corner.mp4

mac.chrome.copy.to.clipboard.move.to.corner.mov

Recording.5008.mp4

MacOS: Desktop

mac.desktop.copy.to.clipboard.move.to.corner.mov

View all open jobs on GitHub

[OSBotify]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open StagingDeployCash deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[melvin-bot]

Triggered auto assignment to @Julesssss (Engineering), see https://stackoverflow.com/c/expensify/questions/4319 for more details.

[mountiny]

Clearly a big but I dont think we have to block deploy on this

[Julesssss]

Yep, removing the blocker label. and updating the checklist.

[melvin-bot]

Triggered auto assignment to @garrettmknight (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[alitoshmatov]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Copy to clipboard tooltip moves to top left corner on copy to clipboard click

What is the root cause of that problem?

Changed button icon when pressed is triggering updateBounds function to recalculate tooltips position.

App/src/components/Tooltip/BaseTooltip.js

Line 129 in 7fdbe50

const updateBounds = (bounds) => {

This function ,in turn, is calling chooseBoundingBox to get bounding box of the button.

App/src/components/Tooltip/BaseTooltip.js

Line 52 in 7fdbe50

return target.getBoundingClientRect();

When mouse is not moved, target element is unmounted from dom, because button icon is changing. Also target only gets updated when mouse is moved. That is why chooseBoundingBox is returning us inaccurate target element. Also fallback bounding box is inaccurate here, since target element is unmounted

App/src/components/Tooltip/BaseTooltip.js

Lines 51 to 52 in 7fdbe50

	// If no matching bounding box is found, fall back to getBoundingClientRect.
	return target.getBoundingClientRect();

What changes do you think we should make in order to solve the problem?

We should utilize bounds argument provided in updateBounds function and set it as fallback in chooseBoundingBox. We can either path bounds to chooseBoundingBox function and replace last return with this:

// If no matching bounding box is found, fall back to getBoundingClientRect.
    return bounds;

Or we can return null from chooseBoundingBox when no valid bounding box is selected, and use available bounds:

const betterBounds = chooseBoundingBox(target.current, initialMousePosition.current.x, initialMousePosition.current.y) || bounds;

What alternative solutions did you explore? (Optional)

[melvin-bot]

Unable to auto-create job on Upwork. The BZ team member should create it manually for this issue.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @abdulrahuman5196 (External)

[garrettmknight]

Reproduced - opening up to external for a fix

[melvin-bot]

⚠️ Could not update price automatically because there is no linked Upwork Job ID. The BZ team member will need to update the price manually in Upwork.

[garrettmknight]

Will create Upwork job when we're ready to assign.

[akamefi202]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Copy to clipboard tooltip moves to top left corner on copy to clipboard click.

What is the root cause of that problem?

App/src/components/Tooltip/BaseTooltip.js

Lines 80 to 83 in 91e2120

	const updateTargetAndMousePosition = useCallback((e) => {
	target.current = e.target;
	initialMousePosition.current = {x: e.clientX, y: e.clientY};
	}, []);

Whenever hover event occurs, updateTargetAndMousePosition function is called to get target of the event.

App/src/components/Tooltip/BaseTooltip.js

Lines 51 to 52 in 91e2120

	// If no matching bounding box is found, fall back to getBoundingClientRect.
	return target.getBoundingClientRect();

And from target, the app gets bounds data to display tooltip.

5. Do not move the cursor and observe that tooltip shifts to top left corner of screen

But in the step 5 of this issue, target of hover event returns <path> tag because the user is pointing on the svg icon.
And the app gets zero as bounds data because <path> tags are not DOMRect objects.
getBoundingClientRect & getClientRects function return empty or zero data in this case.

As a result, we see the tooltip in the top left corner of the screen.

What changes do you think we should make in order to solve the problem?

We should get currentTarget of the event inside updateTargetAndMousePosition function.

target.current = e.currentTarget;

So we can get correct target object which has the handler and we can also get correct bounds data for tooltip.

What alternative solutions did you explore? (Optional)

N/A

[grgia]

All yours @akamefi202! Thank you for your proposal

[akamefi202]

The PR is merged.

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.88-11 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• update updateTargetAndMousePosition function #29968

If no regressions arise, payment will be issued on 2023-10-30. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

For reference, here are some details about the assignees on this issue:

• @s77rt requires payment
• @akamefi202 requires payment
• @dhanashree-sawant requires payment

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@s77rt] The PR that introduced the bug has been identified. Link to the PR:
• [@s77rt] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@s77rt] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@s77rt] Determine if we should create a regression test for this bug.
• [@s77rt] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@garrettmknight] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[s77rt]

• The PR that introduced the bug has been identified: fix chat-link in end of line displays tooltip over text and not on link #29134
• The offending PR has been commented on: fix chat-link in end of line displays tooltip over text and not on link #29134 (comment)
• A discussion in #expensify-bugs has been started: Not needed
• Determine if we should create a regression test for this bug: Yes

---

Regression Test Proposal
https://expensify.testrail.io/index.php?/cases/view/1977387

4. Verify that the correct tooltip is displayed over each of the action options (copy link, download, copy to clipboard, mark as unread)
5. Click the copy to clipboard option
6. Verify the tooltip position stays the same
7. Move the cursor away from the options

[garrettmknight]

QA added - now we wait for payment.

[garrettmknight]

Offers out for payment in the meantime.

[akamefi202]

@garrettmknight I received the offer in Upwork. I should accept it again?

[s77rt]

@garrettmknight No payment is due for me here since it's a regression.

[garrettmknight]

My mistake @s77rt thanks for keeping me honest

[akamefi202]

@garrettmknight Could you please complete this issue if there isn't other problem?

[garrettmknight]

Summarizing payment:

• Urgency bonus: Yes
• Reporter: @dhanashree-sawant $50 paid via Upwork
• Contributor: @akamefi202 $750 paid via Upwork