[Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS #37759

lanitochka17 · 2024-03-05T14:59:51Z

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.47-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/4378569
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:

Go to https://staging.new.expensify.com/
Log in
Create new workspace and rename it
Open the WS chat
Delete the workspace

Expected Result:

Workspace chat has the same name as in step 3

Actual Result:

Workspace chat name and avatar changes to the default. The workspace name should be consistent across #admin, #announce and workspace room

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6402837_1709646269288.WS_with_name_changes_avatar_and_name.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01478bd4327a5c24c1
Upwork Job ID: 1765069975003549696
Last Price Increase: 2024-03-12

Issue Owner

Current Issue Owner: @sobitneupane

melvin-bot · 2024-03-05T15:00:03Z

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

lanitochka17 · 2024-03-05T15:01:37Z

We think that this bug might be related to #wave8
CC @zanyrenney

lanitochka17 · 2024-03-05T15:01:54Z

@twisterdotcom FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

melvin-bot · 2024-03-05T17:40:52Z

Job added to Upwork: https://www.upwork.com/jobs/~01478bd4327a5c24c1

melvin-bot · 2024-03-05T17:40:57Z

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

twisterdotcom · 2024-03-05T17:41:38Z

37759.mp4

FitseTLT · 2024-03-05T18:02:10Z

Proposal

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

Workspace – Workspace chat name and avatar changes to the default after deleting WS

What is the root cause of that problem?

Here we are falling back to policyName on the report but the updated policy name is found oldPolicyName

App/src/libs/ReportUtils.ts

Lines 597 to 598 in 5787691

    
           const policyName = finalPolicy?.name || report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;

as we set oldPolicyName when we delete workspace

App/src/libs/actions/Policy.ts

Lines 298 to 299 in 5787691

    
               oldPolicyName: allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]?.name ?? '', 
        
           },

App/src/types/onyx/Report.ts

Lines 74 to 75 in 5787691

    
           /** The policy name to use for an archived report */ 
        
           oldPolicyName?: string;

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

We need to prioritize oldPolicyName for archived ones as we use for the subtitle of the archived workspace here

App/src/libs/ReportUtils.ts

Lines 2639 to 2641 in 5787691

    
           if (isArchivedRoom(report)) { 
        
               return report?.oldPolicyName ?? ''; 
        
           }

As we might need only to use oldPolicyName for archived workspace we can use isArchivedRoom(report) condition to prioritize oldPolicyName to only use it when the workspace is archived one

App/src/libs/ReportUtils.ts

Lines 597 to 598 in 5787691

    
           const policyName = finalPolicy?.name || report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;

    const policyName = finalPolicy?.name || (isArchivedRoom(report) ? report?.oldPolicyName : report?.policyName)  || report?.oldPolicyName  || parentReport?.oldPolicyName || noPolicyFound;

What alternative solutions did you explore? (Optional)

We can make the change here if we don't want to change the getPolicyName util function that we use in many places

App/src/libs/ReportUtils.ts

Lines 2594 to 2595 in 5787691

    
           if (isPolicyExpenseChat(report)) { 
        
               formattedName = getPolicyExpenseChatName(report, policy);

twisterdotcom · 2024-03-05T21:03:57Z

Just one thing, I came back to this after a few hours and it finally showed the new name:

So... it must be there, it's just reverting back for some time, for some reason.

dukenv0307 · 2024-03-06T04:10:31Z

Proposal

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

Workspace chat name and avatar changes to the default. The workspace name should be consistent across #admin, #announce and workspace room

What is the root cause of that problem?

When we delete the workspace, we update the oldPolicyName for all related reports but we don't set policyName to empty

App/src/libs/actions/Policy.ts

Line 299 in a04481f

    
           oldPolicyName: allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]?.name ?? '',

It leads getPolicyName to return the old name for the report like the policy expense report because when we change the WS name policyName of this still is the old name.

App/src/libs/ReportUtils.ts

Line 597 in a04481f

    
           const policyName = finalPolicy?.name || report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;

After OpenReport API is called, policyName is updated to empty and then the WS name and avatar display correctly

That's the root cause of this issue

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

Since BE will return policyName as empty after we delete the workspace, we should update it as empty in optimistic data to make this work well in offline and before OpenReport API is called

policyName: ''

App/src/libs/actions/Policy.ts

Line 299 in a04481f

    
           oldPolicyName: allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]?.name ?? '',

What alternative solutions did you explore? (Optional)

When we change the display name of WS, we should update policyName of all related reports in optimistic data and BE also needs to update this as well.

askavyblr · 2024-03-06T12:04:50Z

Proposal

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

The chat name and avatar in the workspace are reset to the default. The workspace name must remain consistent across #admin, #announce, and the workspace room.

What is the root cause of that problem?

When the workspace is deleted, we ensure that the oldPolicyName is left empty. here

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

App/src/libs/actions/Policy.ts

Lines 298 to 299 in a04481f

    
           hasDraft: false, 
        
           oldPolicyName: allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]?.name ?? '',

What alternative solutions did you explore? (Optional)

we need to check if Workspace got deleted then use report?.oldPolicyName else report?.policyName

App/src/libs/ReportUtils.ts

Line 597 in a04481f

    
           const policyName = finalPolicy?.name || report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;

twisterdotcom · 2024-03-06T12:49:54Z

@sobitneupane lots of proposals to go at here.

kaushiktd · 2024-03-08T04:54:43Z

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

Workspace – Workspace chat name and avatar changes to the default after deleting WS

What is the root cause of that problem?

The root cause of this problem lies in how the system handles the retrieval of workspace names. Currently, the system prioritizes policyName over oldPolicyName, which leads to the default behavior upon deletion of a workspace.

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

https://github.com/Expensify/App/blob/main/src/libs/ReportUtils.ts#L590

  let finalPolicyName: string | undefined;

    if (policy && [policy.name](http://policy.name/)) {
        finalPolicyName = [policy.name](http://policy.name/); // Use policy name if available
    } else if (isArchivedRoom(report) && report.oldPolicyName) {
        finalPolicyName = report.oldPolicyName; // If the room is archived, use oldPolicyName if available
    } else {
        finalPolicyName = report?.policyName; // Otherwise, use policyName
    }

const policyName = finalPolicyName|| report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;


    return policyName;

Handle finalPolicyName as potentially undefined.

Use policy.name if available.
Use report.oldPolicyName for archived rooms.
Otherwise, use report?.policyName.
Return finalPolicyName, or parentReport?.oldPolicyName, or noPolicyFound if undefined.

Video:-

https://drive.google.com/file/d/1cINMbBK3n5VRVuxrMuVgVQWgGH5r6XSX/view?usp=sharing

Victor-Nyagudi · 2024-03-10T23:12:32Z

I believe the best place to handle this is on the back end such that when a workspace is deleted, report.policyName, when returned, is falsy, therefore, report.oldPolicyName is reached and this is what's shown to the user i.e. the updated workspace's name.

App/src/libs/ReportUtils.ts

Line 597 in a04481f

    
           const policyName = finalPolicy?.name || report?.policyName || report?.oldPolicyName || parentReport?.oldPolicyName || noPolicyFound;

twisterdotcom · 2024-03-11T12:31:56Z

bump @sobitneupane

melvin-bot · 2024-03-12T16:00:05Z

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

sobitneupane · 2024-03-12T16:08:09Z

Thanks for the proposal everyone.

Proposal from @dukenv0307 looks good to me.

🎀 👀 🎀 C+ reviewed

melvin-bot · 2024-03-12T16:08:23Z

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

melvin-bot · 2024-03-14T18:32:46Z

❌ There was an error making the offer to @dukenv0307 for the Contributor role. The BZ member will need to manually hire the contributor.

twisterdotcom · 2024-03-14T21:46:17Z

Not overdue, just hired @dukenv0307

dukenv0307 · 2024-03-15T07:50:50Z

@sobitneupane The PR is ready for review.

melvin-bot · 2024-03-22T16:01:12Z

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

melvin-bot · 2024-03-22T16:01:16Z

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

Update correct policyName in optimistic data #38376

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

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

@sobitneupane requires payment through NewDot Manual Requests
@dukenv0307 requires payment (Needs manual offer from BZ)

melvin-bot · 2024-03-22T16:01:17Z

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:

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

twisterdotcom · 2024-03-29T00:16:58Z

Payment Summary:

@sobitneupane to be paid $500 via newDot requests.
@dukenv0307 paid $500 here

twisterdotcom · 2024-04-08T11:23:55Z

Bump @sobitneupane

cead22 · 2024-04-09T23:54:14Z

No overdue

sobitneupane · 2024-04-11T09:29:44Z

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:

PR that introduced the bug has been identified. Link to the PR:

#33691

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:

#33691 This regression was probably caused by typescript migration PR.

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

Determine if we should create a regression test for this bug.

Yes.

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.

#37759 (comment)

sobitneupane · 2024-04-11T09:32:01Z

Regression Test Proposal

Create a workspace
Change the workspace name
Delete the workspace and go to the archived #admin/#announce room
Verify that the workspace chat avatar and name doesn't change back to the previous workspace name.

Do we agree 👍 or 👎

JmillsExpensify · 2024-04-11T20:51:10Z

$500 approved for @sobitneupane

lanitochka17 added Daily KSv2 Bug Something is broken. Auto assigns a BugZero manager. labels Mar 5, 2024

melvin-bot bot assigned twisterdotcom Mar 5, 2024

twisterdotcom added the External Added to denote the issue can be worked on by a contributor label Mar 5, 2024

melvin-bot bot changed the title ~~Workspace – Workspace chat name and avatar changes to the default after deleting WS~~ [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS Mar 5, 2024

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Mar 5, 2024

melvin-bot bot assigned sobitneupane Mar 5, 2024

twisterdotcom added this to [#whatsnext] Wave 08 - Collect Plan Admins Mar 5, 2024

twisterdotcom moved this to Tracking Issues in [#whatsnext] Wave 08 - Collect Plan Admins Mar 5, 2024

melvin-bot bot added the Overdue label Mar 8, 2024

melvin-bot bot removed the Overdue label Mar 11, 2024

melvin-bot bot assigned cead22 Mar 12, 2024

cead22 assigned dukenv0307 Mar 14, 2024

melvin-bot bot added Overdue and removed Help Wanted Apply this label when an issue is open to proposals by contributors labels Mar 14, 2024

melvin-bot bot removed the Overdue label Mar 14, 2024

dukenv0307 mentioned this issue Mar 15, 2024

Update correct policyName in optimistic data #38376

Merged

50 tasks

melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Daily KSv2 labels Mar 15, 2024

melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels Mar 22, 2024

melvin-bot bot changed the title ~~[$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS~~ [HOLD for payment 2024-03-29] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS Mar 22, 2024

melvin-bot bot removed the Reviewing Has a PR in review label Mar 22, 2024

twisterdotcom changed the title ~~[HOLD for payment 2024-03-29] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS~~ [Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS Mar 29, 2024

melvin-bot bot added the Overdue label Apr 8, 2024

melvin-bot bot removed the Overdue label Apr 11, 2024

twisterdotcom closed this as completed Apr 11, 2024

daledah mentioned this issue Oct 29, 2024

[HOLD for payment 2024-12-19] [$250] Invoices - Workspace avatar changes briefly after invoice receiver deletes workspace #51130

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS #37759

[Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS #37759

lanitochka17 commented Mar 5, 2024 •

edited by twisterdotcom

Loading

melvin-bot bot commented Mar 5, 2024

lanitochka17 commented Mar 5, 2024

lanitochka17 commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

twisterdotcom commented Mar 5, 2024

FitseTLT commented Mar 5, 2024 •

edited

Loading

twisterdotcom commented Mar 5, 2024

dukenv0307 commented Mar 6, 2024 •

edited

Loading

askavyblr commented Mar 6, 2024 •

edited

Loading

twisterdotcom commented Mar 6, 2024

kaushiktd commented Mar 8, 2024 •

edited

Loading

Victor-Nyagudi commented Mar 10, 2024

twisterdotcom commented Mar 11, 2024

melvin-bot bot commented Mar 12, 2024

sobitneupane commented Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

melvin-bot bot commented Mar 14, 2024

twisterdotcom commented Mar 14, 2024

dukenv0307 commented Mar 15, 2024

melvin-bot bot commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024 •

edited by twisterdotcom

Loading

twisterdotcom commented Mar 29, 2024 •

edited

Loading

twisterdotcom commented Apr 8, 2024

cead22 commented Apr 9, 2024

sobitneupane commented Apr 11, 2024 •

edited

Loading

sobitneupane commented Apr 11, 2024

JmillsExpensify commented Apr 11, 2024

[Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS #37759

[Awaiting checklist completion] [$500] Workspace – Workspace chat name and avatar changes to the default after deleting WS #37759

Comments

lanitochka17 commented Mar 5, 2024 • edited by twisterdotcom Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

melvin-bot bot commented Mar 5, 2024

lanitochka17 commented Mar 5, 2024

lanitochka17 commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

melvin-bot bot commented Mar 5, 2024

twisterdotcom commented Mar 5, 2024

FitseTLT commented Mar 5, 2024 • edited Loading

Proposal

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

What is the root cause of that problem?

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

What alternative solutions did you explore? (Optional)

twisterdotcom commented Mar 5, 2024

dukenv0307 commented Mar 6, 2024 • edited Loading

Proposal

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

What is the root cause of that problem?

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

What alternative solutions did you explore? (Optional)

askavyblr commented Mar 6, 2024 • edited Loading

Proposal

twisterdotcom commented Mar 6, 2024

kaushiktd commented Mar 8, 2024 • edited Loading

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

What is the root cause of that problem?

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

Video:-

Victor-Nyagudi commented Mar 10, 2024

twisterdotcom commented Mar 11, 2024

melvin-bot bot commented Mar 12, 2024

sobitneupane commented Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

melvin-bot bot commented Mar 14, 2024

twisterdotcom commented Mar 14, 2024

dukenv0307 commented Mar 15, 2024

melvin-bot bot commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024 • edited by twisterdotcom Loading

twisterdotcom commented Mar 29, 2024 • edited Loading

twisterdotcom commented Apr 8, 2024

cead22 commented Apr 9, 2024

sobitneupane commented Apr 11, 2024 • edited Loading

sobitneupane commented Apr 11, 2024

JmillsExpensify commented Apr 11, 2024

lanitochka17 commented Mar 5, 2024 •

edited by twisterdotcom

Loading

FitseTLT commented Mar 5, 2024 •

edited

Loading

dukenv0307 commented Mar 6, 2024 •

edited

Loading

askavyblr commented Mar 6, 2024 •

edited

Loading

kaushiktd commented Mar 8, 2024 •

edited

Loading

melvin-bot bot commented Mar 22, 2024 •

edited by twisterdotcom

Loading

twisterdotcom commented Mar 29, 2024 •

edited

Loading

sobitneupane commented Apr 11, 2024 •

edited

Loading