[HOLD for payment 2024-03-07] [$500] Workspaces - Сustom avatar is applied to all workspace rooms

[lanitochka17]

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.4.37-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: https://expensify.testrail.io/index.php?/tests/view/4283786&group_by=cases:section_id&group_order=asc&group_id=229065
Email or phone of affected tester (no customers): [email protected]
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: Applause - Internal Team
Slack conversation:

Action Performed:

1. Open NewDat App and WS settings
2. change default Avatar to the custom one
3. check all rooms in the LHN panel

Expected Result:

Verify the Workspace chat displays the new avatar and name.
Default avatars (admins, announce) should have specific icons like at the example.

Actual Result:

All WS rooms (including admins, announce) have the same new custom avatar

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

Add any screenshot/video evidence

Bug6369622_1707241211176.Screen_Recording_2024-02-06_at_18.36.24.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~013fc2b5417b9e2c4a
• Upwork Job ID: 1754928206561398784
• Last Price Increase: 2024-02-13
• Automatic offers:
• akinwale | Contributor | 0
• Tony-MK | Contributor | 0

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~013fc2b5417b9e2c4a

[melvin-bot]

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

[melvin-bot]

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

[lanitochka17]

We think that this bug might be related to #wave6
CC @greg-schroeder

[Tony-MK]

Proposal

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

Workspaces - Сustom avatar is applied to all workspace rooms

What is the root cause of that problem?

The getWorkspaceIcon function is being used for admin and announce rooms in the getIcons function.

App/src/libs/ReportUtils.ts

Lines 1543 to 1544 in 8563c0f

	if (isAdminRoom(report) || isAnnounceRoom(report) || isChatRoom(report) || isArchivedRoom(report)) {
	const workspaceIcon = getWorkspaceIcon(report, policy);

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

We should use getDefualtWorkspaceIcon instead for WS rooms which should only show the default workspace icon.

[ikevin127]

Proposal

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

All WS rooms (including admins, announce) have the same new custom avatar.

What is the root cause of that problem?

Note

The WS rooms which should have default avatars: admin rooms, announce rooms, chat rooms and archived rooms.

Despite the fact that we check the WS room type here in the getIcons function:

App/src/libs/ReportUtils.ts

Line 1542 in 9f37d3e

if (isAdminRoom(report) || isAnnounceRoom(report) || isChatRoom(report) || isArchivedRoom(report)) {

The issue comes from the getWorkspaceIcon function which is called within the if mentioned above:

App/src/libs/ReportUtils.ts

Lines 1443 to 1450 in 9f37d3e

	/**
	* Given a report, return the associated workspace icon.
	*/
	function getWorkspaceIcon(report: OnyxEntry<Report>, policy: OnyxEntry<Policy> = null): Icon {
	const workspaceName = getPolicyName(report, false, policy);
	const policyExpenseChatAvatarSource = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`]?.avatar
	? allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`]?.avatar
	: getDefaultWorkspaceAvatar(workspaceName);

where we can see that regardless of the WS room type, we're always getting the avatar source from the policy?.avatar and only in case that doesn't exist we fallback to getDefaultWorkspaceAvatar.

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

Replace the logic within the WS room types check with the following:

Code spoiler

    if (isAdminRoom(report) || isAnnounceRoom(report) || isChatRoom(report) || isArchivedRoom(report)) {
        const workspaceName = getPolicyName(report, false, policy);
        const workspaceIcon: Icon = {
            source: getDefaultWorkspaceAvatar(workspaceName) ?? '',
            type: CONST.ICON_TYPE_WORKSPACE,
            name: workspaceName,
            id: -1,
        };
        return [workspaceIcon];
    }

essentially using only the part we need from the getWorkspaceIcon function.

What alternative solutions did you explore? (Optional)

Alternatively we can change the getWorkspaceIcon function by adding the check again something like:

Code spoiler

    // ... rest of the function
    let policyExpenseChatAvatarSource = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`]?.avatar ?? getDefaultWorkspaceAvatar(workspaceName);

    if (isAdminRoom(report) || isAnnounceRoom(report) || isChatRoom(report) || isArchivedRoom(report)) {
        policyExpenseChatAvatarSource = getDefaultWorkspaceAvatar(workspaceName);
    }
    // ... rest of the function

Screenshots

MacOS: Chrome / Safari

Before	After

[akinwale]

Taking over as C+ here.

[parasharrajat]

@anmurali @akinwale will be helping here as C+ while I am unavailable.

[akinwale]

This is a fairly straightforward fix and we can move forward with @Tony-MK's proposal here since they were first to arrive at a working solution.

🎀👀🎀 C+ reviewed.

@anmurali I'll need manual assignment as C+, thanks.

[melvin-bot]

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

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[melvin-bot]

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

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[melvin-bot]

📣 @Tony-MK 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[anmurali]

@akinwale I have assigned you and have also accepted @Tony-MK proposal as the job is now assigned to them! Let's get started!

[github-actions]

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

Current assignee @aldo-expensify is eligible for the Engineering assigner, not assigning anyone new.

[aldo-expensify]

I created the PR to revert, is on review now

[aldo-expensify]

TestRail should be updated
https://expensify.testrail.io/index.php?/tests/view/4283786&group_by=cases:section_id&group_order=asc&group_id=229065

Hmm it seems like the test rail steps would not have failed though, so I think this was a mistake.

I think it makes sense to update the tests to include that we should check that Rooms also get the custom avatar.

[aldo-expensify]

Removing deploy blocker label, the revert was CP'd and tested: #37330

[aldo-expensify]

Next steps:

Pay C+ @akinwale and contributor @Tony-MK, and then we can close this out

[melvin-bot]

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

• Revert "fix/35934 | Workspaces - Сustom avatar is applied to all workspace rooms" #37330

If no regressions arise, payment will be issued on 2024-03-07. 🎊

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

• @akinwale requires payment automatic offer (Contributor)
• @Tony-MK requires payment automatic offer (Contributor)

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

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

[muttmuure]

Paying now

[muttmuure]

Paid up, no regression test as it was reverted