Don't treat muted reports as unread in LHN #33779

roryabraham · 2023-12-29T20:17:00Z

Details

This PR accomplishes the following:

DO NOT mark muted reports unread in the LHN (eg, in bold), even if they have unread messages
Hide muted reports in the LHN in focus mode, even if they have unread messages
DO keep showing the "unread indicator" inside the chat

Fixed Issues

$ (partial) #33619

Tests

Setup

Open NewDot in two windows and sign into two accounts, A and B.
Create a DM between A and B
As user A, Click on the report header, and switch the notification preference (Notify me about new messages) to Mute

Scenario 1: regular DM, "most recent" mode

Make sure user A is in "most recent" mode (i.e: not in #focus mode – you can adjust that in Preferences -> Priority Mode)
As user A, Open a different report. If on web, open another tab. If on mobile, background the app.
As user B, send some messages to user A.
As user A, verify
1. You do not receive a push notification
2. The unread count on the app / tab does not increment
After about 20 seconds, as user A, reopen the app. verify that you can see the new messages in the LHN, but the report is not bold in the LHN.
Open the report, and verify that you see the new message marker in the report above the last unread message from user B.

Scenario 2: regular DM, #focus mode

As user A, switch to #focus mode.
As user A, open a different report. Verify that the DM with user B is no longer visible in the LHN.
As user B, send some messages to user A.
As user A, verify that the report does not appear in the LHN.
As user A, use Search to open the DM with user B. Verify that you see the new message marker in the report above the last unread message from user B.

Scenario 3: manual mark as unread, "most recent" mode

As user A, switch to "most recent" mode
As user A, open a report with no unread messages and no green brick road (GBR) indicator.
Right-click or long-press on a message, and mark it as unread.
Verify That the new message marker appears above the message you just marked as unread.
As user A, verify that the report does not appear as bold in the LHN.

Scenario 4: manual mark as unread, #focus mode

As user A, switch to #focus mode
Open a report with no unread messages and no GBR indicator.
Right-click or long-press on a message, and mark it as unread.
Verify That the new message marker appears above the message you just marked as unread.
Open another report.
Verify that the previous report that you just marked as unread is not visible in the LHN.
Using search, open the report you previously marked as unread.
Verify that the new message marker appears above the message you previously marked as unread.

Scenario 5: Money request, #focus mode

As user A, open a report other than the DM with user B, and verify that the DM with user B does not show in the LHN
As user B, request $5 from user A
As user A, verify that the DM with user B appears in the LHN and has a GBR indicator. Verify that it does not appear as bold.
As user A, open the DM with user B and mark the request as settled elsewhere.
As user A, open a different report.
Verify that the DM with user B is no longer visible in the LHN.

~~#### Scenario 6: Task assignment, #focus mode~~
~~1. As user B, open the DM with user A and assign a task to user A.~~
~~1. As user A, verify that the DM with user B appears in the LHN and has a GBR indicator. Verify that is does not appear as bold.~~
~~1. As user A, open the DM with user B and mark the task as completed.~~
~~1. As user A, open a different report.~~
~~1. Verify that the DM with user B is no longer visible in the LHN.~~

Note: Scenario 6 is failing because the task report appears in the LHN as a new, fresh report. Therefore is has a fresh notification preference of Immediately. To fix this, I think all that's needed would be a back-end change to make new reports inherit the notification preference from their parent report. I'm not treating this as a blocker. Slack context

Scenario 7: Mention in a room, #focus mode

As user A, create a workspace
Invite user B to the workspace as a member.
As user A, create a room in the new workspace, visible to workspace members with permissions for all members to comment.
As user A, click on the room header, go to settings, and update the notification preference to Mute
As user B, join the new room.
As user A, open another report and verify that the room is not visible in the LHN.
As user A, open another tab or background the app.
As user B, open the room and send a message mentioning user A.
As user A, verify that you do not receive a push notification and that the unread count for the app does not increase.
After about 20 seconds, as user A, reopen the app. verify that the room appears in the LHN with a GBR indicator. Verify that it does not appear as bold.
As user A, open the room and read the message send by user B.
As user A, open another report.
Verify that the room is no longer visible in the LHN.

Scenario 8: Pinning a chat, #focus mode

As user A, verify that the DM with user B is not visible in the LHN.
Using search, open the DM with user B.
Click on the three dots details menu in the report header, and pin the chat.
Open a different report.
Verify that the pinned chat remains visible in the LHN.
As user B, send a message in the DM with user A.
As user A, verify that the pinned DM with user B remains visible, but is not bold.
As user B, mention user A in a message.
As user A, verify that the pinned DM with user B remains visible, and now has a GBR indicator. Verify that it is not bold.

Scenario 9: Basic regression test

As User A, unmute the chat DM with user B, then open a different report.
As User B, send a DM to user A
As User A, verify that the chat from B is visible in the LHN and appears as bold / unread.

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Same as test steps
Important: Once complete, please create a follow-up GitHub issue to update TestRail to include regression steps covering the test steps from this PR, and comment on this PR to link the follow-up issue.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Scenario 1

Android: Native

android1.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iosWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 2

Android: Native

android2.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 3

Android: Native

android3.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 4

Android: Native

android4.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 5

Android: Native

android5.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

~~Scenario 6~~

Scenario 7

Android: Native

android7.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 8

Android: Native

android8.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Scenario 9

Android: Native

android9.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iOSWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2023-12-29T20:17:32Z

@rlinoz Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

github-actions · 2024-01-20T06:48:08Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/33779/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
❌ FAILED ❌	https://33779.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

👀 View the workflow run that generated this build 👀

# Conflicts: # src/libs/ReportUtils.ts

roryabraham · 2024-01-22T18:01:47Z

Ready for review! cc @rlinoz

akinwale · 2024-01-22T20:24:01Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Scenario 1

33779-scenario-1.mp4

Scenario 2

33779-scenario-2.mp4

Scenario 3

33779-scenario-3.mp4

Scenario 4

33779-scenario-4.mp4

Scenario 5

33779-scenario-5.mp4

Scenario 6

33779-scenario-6.mp4

Scenario 7

33779-scenario-7_1.mp4

33779-scenario-7_2.mp4

Scenario 8

33779-scenario-8.mp4

MacOS: Desktop

akinwale · 2024-01-23T04:22:47Z

src/libs/ReportUtils.ts

@@ -3662,7 +3663,7 @@ function shouldReportBeInOptionList({

    // All unread chats (even archived ones) in GSD mode will be shown. This is because GSD mode is specifically for focusing the user on the most relevant chats, primarily, the unread ones
    if (isInGSDMode) {


NAB, but it would be nice to have some sort of comment that gives a hint what GSD mode is (in relation to focus mode and/or recent mode).

akinwale

LGTM.

All scenarios test well.

melvin-bot · 2024-01-23T04:23:30Z

@arosiclair Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

melvin-bot · 2024-01-23T04:23:33Z

🎯 @akinwale, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #34943.

rlinoz · 2024-01-23T15:25:01Z

Hey @roryabraham , code looks good!

I just got this scenario, want to know if it is a problem:

Scenario 7: Mention in a room, #focus mode

When sending a message with user B in a room the notification count shown in the tab goes up for user A

roryabraham · 2024-01-23T23:52:05Z

@rlinoz good question – let's ask in slack

Edit: brought to slack, but I went ahead and fixed the bug. Great catch @rlinoz! Updating the testing steps to account for that...

# Conflicts: # src/components/LHNOptionsList/OptionRowLHN.tsx # src/libs/ReportUtils.ts

rlinoz

👍

OSBotify · 2024-01-24T12:43:02Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-01-25T09:06:34Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.32-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-01-29T19:06:19Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.32-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

roryabraham added 2 commits December 29, 2023 11:51

Dont make unread muted reports bold in the LHN

0095e33

Hide muted reports in focus mode

12b30ec

roryabraham self-assigned this Dec 29, 2023

roryabraham requested a review from a team as a code owner December 29, 2023 20:17

melvin-bot bot removed the request for review from a team December 29, 2023 20:17

melvin-bot bot requested a review from rlinoz December 29, 2023 20:17

roryabraham mentioned this pull request Dec 29, 2023

CRITICAL: Update Mute behavior to not show as unread in the LHN. #33619

Closed

roryabraham added 2 commits January 3, 2024 16:49

Merge branch 'main' into Rory-MuteUnread

76c33cf

Merge branch 'main' into Rory-MuteUnread

94f42c7

roryabraham requested a review from akinwale January 8, 2024 17:13

roryabraham added 3 commits January 12, 2024 10:58

Merge branch 'main' into Rory-MuteUnread

6a96df0

Merge branch 'main' into Rory-MuteUnread

e1a72f5

Include isUnreadWithMention in selector

5f81b8d

roryabraham added the Ready To Build label Jan 20, 2024

Merge branch 'main' into Rory-MuteUnread

3b8dd43

# Conflicts: # src/libs/ReportUtils.ts

roryabraham changed the title ~~[WIP] Don't treat muted reports as unread in LHN~~ Don't treat muted reports as unread in LHN Jan 22, 2024

akinwale reviewed Jan 23, 2024

View reviewed changes

akinwale approved these changes Jan 23, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair January 23, 2024 04:23

melvin-bot bot mentioned this pull request Jan 23, 2024

[HOLD for payment 2024-02-05] Payment issue for E/App PR#33779 #34943

Closed

roryabraham added 2 commits January 23, 2024 16:00

Merge branch 'main' into Rory-MuteUnread

9571532

# Conflicts: # src/components/LHNOptionsList/OptionRowLHN.tsx # src/libs/ReportUtils.ts

Fix typo in merge conflict resolution

970183a

Don't include muted reports in unread count

9c9c654

rlinoz approved these changes Jan 24, 2024

View reviewed changes

rlinoz merged commit edf0fd0 into main Jan 24, 2024
16 checks passed

rlinoz deleted the Rory-MuteUnread branch January 24, 2024 12:38

github-actions bot mentioned this pull request Jan 25, 2024

Deploy Checklist: New Expensify 2024-01-25 #35138

Closed

48 tasks

bernhardoj mentioned this pull request Apr 5, 2024

[$250] Unbold Self DM Email in LHN when Marked Unread #39712

Closed

6 tasks

Ollyws mentioned this pull request Apr 26, 2024

[$250] Unread chats are not shown bold but shown as unread when search #38704

Closed

6 tasks

wildan-m mentioned this pull request Jul 23, 2024

[Awaiting BZ checklist][$500] LHN – Offline created chat disappears from LHN when come back online #44829

Closed

6 tasks

blimpich mentioned this pull request Oct 24, 2024

[$250] Self DM - Self DM is not bolded in LHN after it is marked as unread #51362

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't treat muted reports as unread in LHN #33779

Don't treat muted reports as unread in LHN #33779

roryabraham commented Dec 29, 2023 •

edited

Loading

melvin-bot bot commented Dec 29, 2023

github-actions bot commented Jan 20, 2024

roryabraham commented Jan 22, 2024

akinwale commented Jan 22, 2024 •

edited

Loading

akinwale Jan 23, 2024

akinwale left a comment

melvin-bot bot commented Jan 23, 2024

melvin-bot bot commented Jan 23, 2024

rlinoz commented Jan 23, 2024

roryabraham commented Jan 23, 2024 •

edited

Loading

rlinoz left a comment

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

OSBotify commented Jan 29, 2024

		@@ -3662,7 +3663,7 @@ function shouldReportBeInOptionList({

		// All unread chats (even archived ones) in GSD mode will be shown. This is because GSD mode is specifically for focusing the user on the most relevant chats, primarily, the unread ones
		if (isInGSDMode) {

Don't treat muted reports as unread in LHN #33779

Don't treat muted reports as unread in LHN #33779

Conversation

roryabraham commented Dec 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Setup

Scenario 1: regular DM, "most recent" mode

Scenario 2: regular DM, #focus mode

Scenario 3: manual mark as unread, "most recent" mode

Scenario 4: manual mark as unread, #focus mode

Scenario 5: Money request, #focus mode

Scenario 7: Mention in a room, #focus mode

Scenario 8: Pinning a chat, #focus mode

Scenario 9: Basic regression test

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 29, 2023

github-actions bot commented Jan 20, 2024

roryabraham commented Jan 22, 2024

akinwale commented Jan 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

akinwale Jan 23, 2024

Choose a reason for hiding this comment

akinwale left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 23, 2024

melvin-bot bot commented Jan 23, 2024

rlinoz commented Jan 23, 2024

roryabraham commented Jan 23, 2024 • edited Loading

rlinoz left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

OSBotify commented Jan 29, 2024

roryabraham commented Dec 29, 2023 •

edited

Loading

akinwale commented Jan 22, 2024 •

edited

Loading

roryabraham commented Jan 23, 2024 •

edited

Loading