[$500] Chat - Console error shows up when receiving message in #announce room

[lanitochka17]

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

---

Issue found when executing PR #26850

Action Performed:

1. Go to staging.new.expensify.com
2. User A and User B stay in #announce room
3. User B sends a message (text or attachment) to User A

Expected Result:

Console error will not show up on receiver end (User A)

Actual Result:

Console error shows up on receiver end (User A)

Workaround:

Unknown

Platforms:

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

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

Version Number: 1.3.70-2

Reproducible in staging?: Yes

Reproducible in production?: Yes

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

Bug6200454_20230914_220712.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0183471120ce59aad5
• Upwork Job ID: 1702337125677191168
• Last Price Increase: 2023-09-14

[melvin-bot]

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

[akinwale]

Proposal

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

Console error shows up when receiving message in #announce room.

What is the root cause of that problem?

In BrowserNotifications, we try to obtain the displayName as the roomName from the report. However, #announce rooms do not have the displayName property in their corresponding report object. They only have reportName.

App/src/libs/Notification/LocalNotification/BrowserNotifications.js

Lines 113 to 114 in 95c9e47

	if (isChatRoom) {
	const roomName = _.get(report, 'displayName', '');

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

Change the implementation to try to get the displayName property first, and if that doesn't exist, use the reportName property instead.

-const roomName = _.get(report, 'displayName', '');
+const roomName = _.get(report, 'displayName', _.get(report, 'reportName', ''));

or

+const roomName = _.has(report, 'displayName') ? _.get(report, 'displayName', '') : _.get(report, 'reportName', '');

We can also consider setting a default string if neither displayName nor reportName exists as a property of the report object instead of empty string. This will prevent the possibility of future console errors resulting from an empty title which is derived from the roomName const.

Alternatively, if we don't use a default string, perform an early return if the value ends up being an empty string in this scenario.

What alternative solutions did you explore? (Optional)

None.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0183471120ce59aad5

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

📣 @MuzanEDM! 📣
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>

[Pujan92]

Are we passing earlier displayName for these rooms as it is only used while making this change here in this PR, if so then we need to pass displayName for these reports from backend.

[bernhardoj]

Proposal

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

Console error and no notification received when sending a new message from another client on a chat room.

What is the root cause of that problem?

The error happens when we are constructing the title and body text of the notification. If it's a chat room, we want the title of the notification to be the room name and we get it from displayName property of a report.

App/src/libs/Notification/LocalNotification/BrowserNotifications.js

Lines 113 to 116 in 95c9e47

	if (isChatRoom) {
	const roomName = _.get(report, 'displayName', '');
	title = roomName;
	body = `${plainTextPerson}: ${plainTextMessage}`;

However, displayName is actually a non-existent property. This issue has the same root cause as this one and the root cause is explained in this proposal.

TLDR;
displayName is previously available because we are mutating the global report object in getOrderedReportIDs by adding displayName property to it. It's not the case now, so displayName is undefined.

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

The solution is (also the same as the mentioned issue above) to use ReportUtils.getReportName(report) to get the name.

const roomName = ReportUtils.getReportName(report)

[hungvu193]

Dupe of #23234

[puneetlath]

Thanks @hungvu193