[HOLD for payment 2023-11-02] [$500] Chat - Wrong sub avatar for split bill

kbecciv commented 11 months ago

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

Version Number: 1.3.84.0 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 Expensify/Expensify Issue URL: Issue reported by: @dhanashree-sawant Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1697216946635739

Action Performed:

Open the app and login with user A
Open the app in another device and login with user B
From user A, invite user B in any workspace
From user B, click on green plus and click on request money
Enter any amount and continue
Click on split button besides workspace report used in step 3 and complete further process
From user A, open workspace chat created after inviting user B to a workspace
From user A, in workspace chat, observe the split bill avatar, it displays default profile sub avatar and on hover on it, it displays same user tooltip (It should display workspace square avatar as it does on production)

Expected Result:

App should display workspace profile in split message as sub avatar

Actual Result:

App displays default profile image avatar of same user in split message

Workaround:

Unknown

Platforms:

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

[x] Android: Native
[x] Android: mWeb Chrome
[x] iOS: Native
[x] iOS: mWeb Safari
[x] MacOS: Chrome / Safari
[x] MacOS: Desktop

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/93399543/db9f25c6-8288-4e32-9671-9f93164893f7

Android: mWeb Chrome

https://github.com/Expensify/App/assets/93399543/b6165d08-2240-40cc-ad43-24f6a5cf86fb

iOS: Native

https://github.com/Expensify/App/assets/93399543/92368c32-53f6-4b8a-a401-347c389bf26e

iOS: mWeb Safari

https://github.com/Expensify/App/assets/93399543/0f709996-b8f5-4949-bb0d-a734b7b53c50

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/93399543/644ebd7a-02a2-478e-bfb2-f65ab343948c https://github.com/Expensify/App/assets/93399543/dd2440a3-b625-44fe-a8e5-476709e0b790 https://github.com/Expensify/App/assets/93399543/26dc0c6a-4d4f-4e3f-a8a6-099b32e14c24

MacOS: Desktop

https://github.com/Expensify/App/assets/93399543/867d9f12-274a-4625-85d6-c0b376833b18

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01d1fdbe3efd12338f
Upwork Job ID: 1713231723488018432
Last Price Increase: 2023-10-14
Automatic offers:

cubuspl42 | Reviewer | 27291697
dhanashree-sawant | Reporter | 27291698

melvin-bot[bot] commented 11 months ago

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

melvin-bot[bot] commented 11 months ago

Job added to Upwork: https://www.upwork.com/jobs/~01d1fdbe3efd12338f

melvin-bot[bot] commented 11 months ago

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

melvin-bot[bot] commented 11 months ago

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

wlegolas commented 11 months ago

Proposal

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

Chat - Wrong sub avatar for split bill

What is the root cause of that problem?

The problem is inside the ReportActionItemSingle component when the condition below is false.

const isWorkspaceActor = ReportUtils.isPolicyExpenseChat(props.report) && (!actorAccountID || displayAllActors);

To retrieve the Workspace's icon (AKA "secondaryAvatar") for this kind of Report chat ("policyExpenseChat"), is used the method getIcons from the ReportUtils as you can see in the image below:

The method getIcons returns a tuple with the icons whose positions depend on the Report type.

When the Report type is expense then the position Zero will have the member icon, and the position One will have the workspace icon, otherwise the position Zero will have the workspace icon, and the position One member icon.

function getIcons(report, personalDetails, defaultIcon = null, defaultName = '', defaultAccountID = -1, policy = undefined) {
    ...
    if (isPolicyExpenseChat(report) || isExpenseReport(report)) {
        const workspaceIcon = getWorkspaceIcon(report, policy);
        const memberIcon = {
            source: UserUtils.getAvatar(lodashGet(personalDetails, [report.ownerAccountID, 'avatar']), report.ownerAccountID),
            id: report.ownerAccountID,
            type: CONST.ICON_TYPE_AVATAR,
            name: lodashGet(personalDetails, [report.ownerAccountID, 'displayName'], ''),
            fallbackIcon: lodashGet(personalDetails, [report.ownerAccountID, 'fallbackIcon']),
        };
        return isExpenseReport(report) ? [memberIcon, workspaceIcon] : [workspaceIcon, memberIcon];
    }
    ...
}

In the ReportActionItemSingle component, to know which position has the secondaryAvatar is checked if the isOwnPolicyExpenseChat property in the Report has the value true, if yes, it gets the position Zero, otherwise, the position One. (as you can see in the first image)

The problem is that the ReportActionItemSingle component uses the position One where there is the memberIcon object because the isOwnPolicyExpenseChat property in the Report has the value false.

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

To get the correct position in the tuple, we should add a condition to use the position Zero if the isOwnPolicyExpenseChat property in the Report has the value true (current logic) or if this Report is a policy Expense chat.

What alternative solutions did you explore? (Optional)

I tried to understand why the getIcons methods should return a tuple with different values for the index related to the Report's type, but there are many locals that use this method and change this piece of code to return always the same values in the same position without tests is a change that I thought could bring other issues.

Fix evidence:

https://github.com/Expensify/App/assets/698363/252b856d-e53e-4d38-8924-6f2e793d9e7f

Tony-MK commented 11 months ago

Proposal

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

Wrong sub avatar for split bill

What is the root cause of that problem?

The root cause of the problem is that the secondaryAvatar variable is the memberIcon instead of being the workspaceIcon after the spilt action occurs.

https://github.com/Expensify/App/blob/fe282b45cb13e01519282ccc023e5bfbd7714158/src/pages/home/report/ReportActionItemSingle.js#L129

After the spilt action is created, the isExpenseReport function outputs false when the first report action, the money request, is passed through it. Since, report.action.isOwnPolicyExpenseChat is false for user A, it will select the second icon item in the output array from getIcons function which is the memberIcon.

https://github.com/Expensify/App/blob/fe282b45cb13e01519282ccc023e5bfbd7714158/src/libs/ReportUtils.js#L1113-L1122

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

Since we need to get the workspaceIcon instead of the memberIcon from the icons array, I believe that adding other condition for checking if the report is the not an expense report.

https://github.com/Expensify/App/blob/fe282b45cb13e01519282ccc023e5bfbd7714158/src/pages/home/report/ReportActionItemSingle.js#L129

Therefore, changing the above line of code to something similar to the one below should allow the workspaceIcon can be selected for secondaryAvatar.

secondaryAvatar = ReportUtils.getIcons(props.report, {})[props.action.isOwnPolicyExpenseChat || !ReportUtils.isExpenseReport(props.report) ? 0 : 1];

JmillsExpensify commented 11 months ago

@cubuspl42 thoughts on the proposals so far?

cubuspl42 commented 11 months ago

@Tony-MK Isn't your proposal essentially equivalent to the earlier one?

Tony-MK commented 11 months ago

@cubuspl42 Thanks for reviewing my proposal. I believe my proposal has the same RCA as the one before. The difference is the solution. The added condition in my proposal checks if the report is not an expense report. Unlike the previous proposal, I suggest using the negation of the output from the ReportUtils.isExpenseReport function. While, the previous proposal checks if the Report is a policy Expense chat.

cubuspl42 commented 11 months ago

@wlegolas Do you maybe have a Git branch with the code you used to test your idea?

wlegolas commented 11 months ago

Hi @cubuspl42 yes I already have. That video I created using my branch, but I haven't pushed this branch yet.

cubuspl42 commented 11 months ago

Would you share it?

wlegolas commented 11 months ago

Sure @cubuspl42, here is the link with the changes I did to fix this issue.

https://github.com/Expensify/App/compare/main...wlegolas:ExpensifyApp:bugfix/issue-29614

If you have any questions or suggestions, please let me know.

wlegolas commented 11 months ago

Hi @cubuspl42 I updated my branch with a Unit Test to validate this issue.

You can see all changes in this link: https://github.com/Expensify/App/compare/main...wlegolas:ExpensifyApp:bugfix/issue-29614

cubuspl42 commented 11 months ago

@wlegolas

Your root cause analysis sounds solid and I appreciate the efforts to add tests!

We can move forward with the proposal by @wlegolas

C+ reviewed 🎀 👀 🎀

melvin-bot[bot] commented 11 months ago

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

melvin-bot[bot] commented 11 months ago

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

Offer link Upwork job

melvin-bot[bot] commented 11 months ago

📣 @wlegolas 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[bot] commented 11 months ago

📣 @dhanashree-sawant 🎉 An offer has been automatically sent to your Upwork account for the Reporter role 🎉 Thanks for contributing to the Expensify app!

Offer link Upwork job

wlegolas commented 11 months ago

Hi @cubuspl42 thank you for your feedback about my proposal and the tests.

I'll post today the PR with these changes and I'll let you know when the PR is available for review.

wlegolas commented 11 months ago

Hi @cubuspl42 I opened the PR: https://github.com/Expensify/App/pull/30068

If you have any questions or suggestions, feel free to ask me.

JmillsExpensify commented 11 months ago

PR review in progress

melvin-bot[bot] commented 11 months ago

Based on my calculations, the pull request did not get merged within 3 working days of assignment. Please, check out my computations here:

when @wlegolas got assigned: 2023-10-20 08:41:52 Z
when the PR got merged: 2023-10-25 14:47:09 UTC
days elapsed: 3

On to the next one 🚀

wlegolas commented 11 months ago

Hi @JmillsExpensify.

I didn't receive the offer for this job in my Upwork account, could you help me, please?

melvin-bot[bot] commented 11 months ago

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

melvin-bot[bot] commented 11 months ago

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

https://github.com/Expensify/App/pull/30068

If no regressions arise, payment will be issued on 2023-11-02. :confetti_ball:

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:

@wlegolas requires payment
@cubuspl42 requires payment offer (Reviewer)
@dhanashree-sawant requires payment offer (Reporter)

melvin-bot[bot] commented 11 months ago

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:

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

techievivek commented 10 months ago

Not overdue, @cubuspl42 can you please fill out the above checklist 🙏

techievivek commented 10 months ago

@JmillsExpensify It looks like @wlegolas hasn't received an upwork offer https://github.com/Expensify/App/issues/29614#issuecomment-1781927656, can you please take a look into it.

cubuspl42 commented 10 months ago

The PR that introduced the bug has been identified. Link to the PR:
- N/A; As I understand this, this bug is more of an unimplemented case than a regression
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:
- N/A
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:
- No need for additional discussion
Determine if we should create a regression test for this bug.
- Up to the QA team
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.
- Open the app and login with user A
- Open the app on another device and login with user B
- From user A, invite user B to any workspace
- From user B, click on green plus and click on request money
- Enter any amount and continue
- Press the "Split" button beside the workspace name, press "Add to split" and confirm the split summary
- From user A, open workspace chat was created after inviting user B to a workspace
- From user A, in workspace chat, observe the secondary (small) avatar, ensure that the initial letter is from the workspace name, and when hovering, ensure that the tooltip shows the workspace name.

JmillsExpensify commented 10 months ago

Thanks for closing the loop on that regression test. I'll get it added.

JmillsExpensify commented 10 months ago

Payment issue:

Issue reporter: @dhanashree-sawant $50
Contributor: @cubuspl42 $500
Contributor+: @wlegolas $500

wlegolas commented 10 months ago

Hi @JmillsExpensify

I asked in this comment https://github.com/Expensify/App/issues/29614#issuecomment-1781927656 that I haven't received an Upwork offer.

When I started this fix, I followed the instructions in this comment https://github.com/Expensify/App/issues/29614#issuecomment-1772323420 and applied to the Upwork job, but I don't know just applying to this job is enough.

Could you please help me understand if there is something else that I or you need to do?

techievivek commented 10 months ago

@JmillsExpensify It looks like @wlegolas hasn't received an offer yet. Can you please take a look and help them with the next step, thanks.

wlegolas commented 10 months ago

Hi @JmillsExpensify if I need to do something from my said, please let me know.

I followed the instructions in this comment https://github.com/Expensify/App/issues/29614#issuecomment-1772323420 applying to this job in Upwork, I don't know if can help you.

melvin-bot[bot] commented 10 months ago

@wlegolas, @JmillsExpensify, @cubuspl42, @techievivek Eep! 4 days overdue now. Issues have feelings too...

techievivek commented 10 months ago

Gentle bump @JmillsExpensify ^

JmillsExpensify commented 10 months ago

Sorry missed the notifications. Jumping in to resolve payments now!

JmillsExpensify commented 10 months ago

Contributors with contracts paid out. @wlegolas if you're online at the moment, please accept the offer in Upwork and I'll make sure it's processed. Thank you!

wlegolas commented 10 months ago

Hi @JmillsExpensify I accepted the offer.

Thank you so much.

JmillsExpensify commented 10 months ago

All paid out and the regression test has been created. Closing this one out!

Expensify / App