[HOLD for payment 2023-07-17] [$1000] Tooltip breaks on dynamic update of display name in new group list

[kavimuru]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Open the app and login with user A
2. Open the app on another device and login with user B
3. In user A device, click on plus, new group, search for user B and hover once on avatar to observe tooltip
4. In user B device, go to settings, profile, display name and change display name to very long first and last name
5. Hover again on user B avatar on user A device to observe that tooltip is not distorted and not positioned properly
6. close new group menu on user A device, again open new group, search for user B and again hover on user B avatar to observe that now it looks right and is positioned properly

Expected Result:

App should adjust tooltip width too dynamically to ensure it looks right when display name length changes.

Actual Result:

App only updates display name dynamically and not width of tooltip when hovered on user on new group page and that user changes its name

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.32-5
Reproducible in staging?: y
Reproducible in production?: y
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
Notes/Photos/Videos: Any additional supporting documentation

Recording.909.mp4

Tooltip.breaks.on.dynamic.update.new.group.mp4

Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1687356088987299

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~011f7af8c7b650e009
• Upwork Job ID: 1674404124264230912
• Last Price Increase: 2023-06-29

[melvin-bot]

Triggered auto assignment to @CortneyOfstad (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

[cubuspl42]

Proposal

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

When the user's display name updates while a component that contains that user's display name in its tooltip is rendered, the tooltip does not update its layout and starts flickering when shown.

What is the root cause of that problem?

UserDetailsTooltip passes renderTooltipContent to Tooltip, but does not pass any renderTooltipContentKey, so the tooltip doesn't know that it should recompute its layout.

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

We should pass elements that could affect the tooltip's layout to renderTooltipContentKey.

    return (
        <Tooltip
            renderTooltipContent={renderTooltipContent}
            renderTooltipContentKey={[userDetails.displayName, userDetails.login]}
        >
            {props.children}
        </Tooltip>
    );

My branch

[CortneyOfstad]

Was able to recreate on my side as well, so going to get eyes on the proposal 👍

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~011f7af8c7b650e009

[melvin-bot]

Current assignee @CortneyOfstad is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[CortneyOfstad]

@aimane-chnaif Any thoughts on the above propsal?

[allroundexperts]

@mallenexpensify I think #21419 is very different from this issue. Both should be handled separately.

[mallenexpensify]

Thanks @allroundexperts

@aimane-chnaif Can you please review the above proposal, it's been over a week since it was posted :/
#21622 (comment)

[aimane-chnaif]

@cubuspl42's proposal looks good to me.
I think renderTooltipContentKey={[userDisplayName]} should be enough as userLogin won't change.
🎀 👀 🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @danieldoglas, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[melvin-bot]

📣 @aimane-chnaif 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Upwork job

[melvin-bot]

📣 @cubuspl42 You have been assigned to this job!
Please apply to the Upwork job and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Once you apply to this job, your Upwork ID will be stored and you will be automatically hired for future jobs!
Keep in mind: Code of Conduct | Contributing 📖

[melvin-bot]

📣 @dhanashree! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
2. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
3. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[melvin-bot]

The BZ member will need to manually hire dhanashree for the Reporter role. Please store your Upwork details and apply to our Upwork job so this process is automatic in the future!

[melvin-bot]

🎯 ⚡️ Woah @aimane-chnaif / @cubuspl42, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @cubuspl42 got assigned: 2023-07-04 22:06:35 Z
• when the PR got merged: 2023-07-06 17:07:55 UTC

On to the next one 🚀

[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.38-7 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• UserDetailsTooltip: Pass renderTooltipContentKey to Tooltip #22246

If no regressions arise, payment will be issued on 2023-07-17. 🎊

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

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:

• [@aimane-chnaif] The PR that introduced the bug has been identified. Link to the PR:
• [@aimane-chnaif] 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:
• [@aimane-chnaif] 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:
• [@aimane-chnaif] Determine if we should create a regression test for this bug.
• [@aimane-chnaif] 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.
• [@CortneyOfstad] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: No regression needed per this comment below

[CortneyOfstad]

@aimane-chnaif any updates on the checklist above?

[CortneyOfstad]

@aimane-chnaif Bump on the check list above. I cannot move forward with the regression steps until those are completed 👍

[aimane-chnaif]

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:

• [@aimane-chnaif] The PR that introduced the bug has been identified. Link to the PR: Cloudpresser/user details tooltip #20276
• [@aimane-chnaif] 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: https://github.com/Expensify/App/pull/20276/files#r1268130024
• [@aimane-chnaif] 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: N/A
• [@aimane-chnaif] Determine if we should create a regression test for this bug.
• [@aimane-chnaif] 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.

No regressions but this was missing case while implementing new feature of user details tooltip.
As this is kind of dynamic update issues which are closed recently, I don't think regression test step is needed.

[CortneyOfstad]

@aimane-chnaif You have been paid, so all set there!

@cubuspl42 and @dhanashree-sawant — sent contracts to both of you. Please accept them in Upwork and let me know here, so I can get those paid to you ASAP. Thank you!

[cubuspl42]

@CortneyOfstad Thanks, accepted. What about the bonus? 🙂

[CortneyOfstad]

Yep, bonus was applied and both of you have been paid with the contracts ending. Thank you!