Updated logic to handle unread messages case #25935

gedu · 2023-08-25T13:39:07Z

Details

Fixed Issues

$ #23171
PROPOSAL: -

Tests

Verify that no errors appear in the JS console

have 2 accounts
with user A, mark a message as unread
with user B, start sending many messages
user A should see the unread marker in the same message
user A can send a message and the marker still showing

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

markingUnread_multiple_messages_chrome.mp4

markingUnread_multiple_messages_safari.mp4

Mobile Web - Chrome

markingUnread_multiple_messages_androidWeb.mp4

Mobile Web - Safari

markingUnread_multiple_messages_iPhoneWeb.mp4

Desktop

markingUnread_multiple_messages_desktop.mp4

iOS

markingUnread_multiple_messages_iPhone.mp4

Android

markingUnread_multiple_messages_android.mp4

# Conflicts: # src/pages/home/report/ReportActionsList.js

MonilBhavsar

Some issues with marker not being displayed when revisiting the chat after marking it as unread. DM'ed Eduardo

# Conflicts: # src/pages/home/report/ReportActionsList.js

melvin-bot · 2023-09-29T12:56:43Z

@allroundexperts 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]

MonilBhavsar · 2023-10-03T05:00:05Z

@allroundexperts could you please take a look.
@gedu there are conflicts again 😬

# Conflicts: # src/pages/home/report/ReportActionsList.js

gedu · 2023-10-03T08:36:03Z

@MonilBhavsar conflicts solved

allroundexperts · 2023-10-03T21:29:42Z

@allroundexperts could you please take a look. @gedu there are conflicts again 😬

On it!

allroundexperts · 2023-10-03T21:32:38Z

src/libs/actions/Report.js

@@ -842,6 +842,8 @@ function readNewestAction(reportID) {
 *
 * @param {String} reportID
 * @param {String} reportActionCreated
+ *
+ * @returns {String} lastReadTime


This is weird. I'm not sure if we're returning unrelated parameters from an action elsewhere. A better way would be to just use onyx to get lastReadTime from the report.

it was for emitting the even, but I will move the emitting into the function, so it won't need to return it

allroundexperts · 2023-10-03T21:33:53Z

src/pages/home/report/ContextMenu/ContextMenuActions.js

@@ -251,7 +252,8 @@ export default [
        shouldShow: (type, reportAction, isArchivedRoom, betas, anchor, isChronosReport, reportID, isPinnedChat, isUnreadChat) =>
            type === CONTEXT_MENU_TYPES.REPORT_ACTION || (type === CONTEXT_MENU_TYPES.REPORT && !isUnreadChat),
        onPress: (closePopover, {reportAction, reportID}) => {
-            Report.markCommentAsUnread(reportID, reportAction.created);
+            const lastReadTime = Report.markCommentAsUnread(reportID, reportAction.created);
+            DeviceEventEmitter.emit(`unreadAction_${reportID}`, lastReadTime);


Can't we inside from inside the action? I think that would be better since we won't be requiring the action to return stuff.

allroundexperts · 2023-10-03T21:37:27Z

src/pages/home/report/ReportActionsList.js

+            cacheUnreadMarkers.delete(report.reportID);
+            lastReadRef.current = newLastReadTime;
+            setCurrentUnreadMarker(null);
+            setMessageManuallyMarkedUnread(new Date().getTime());


I haven't seen this event driven pattern used in our app before. Would you mind explaining why this is needed?

Was added here point 3.
I just moved the code around because of conflicts. Basically setting a new number produces a rerender, but when is clean, setting 0, and we try to set 0 again, because it is 0 already no rerender event is fired

# Conflicts: # src/pages/home/report/ReportActionsList.js

gedu · 2023-10-09T09:20:29Z

@allroundexperts Conflicts solved + comments

gedu · 2023-11-15T21:49:59Z

I just took a look at it, and the bug wasn't coming from our code, was coming from PusherUtils, but after merging again with main I couldn't reproduce the bug. It is all pushed, if you can give it another round. @MonilBhavsar @shubham1206agra

Screen.Recording.2023-11-15.at.21.07.08.mp4

shubham1206agra · 2023-11-16T07:09:45Z

Have you pushed the merge commit? @gedu
Cause I can still able to repro this on this PR.

gedu · 2023-11-16T12:59:31Z

@shubham1206agra @MonilBhavsar pushed the merge

gedu · 2023-11-16T13:19:14Z

Checking again, because @MonilBhavsar can reproduce it, and I just could reproduce it again

shubham1206agra · 2023-11-16T13:22:26Z

@gedu Can you check the repro on main also?

MonilBhavsar · 2023-11-16T13:24:29Z

It is not reproducible on main for me

MonilBhavsar · 2023-11-16T14:03:30Z

Thanks! It works fine for me now. @shubham1206agra could you also please confirm, thanks

shubham1206agra · 2023-11-16T14:09:50Z

@MonilBhavsar Working fine now

MonilBhavsar · 2023-11-16T14:12:03Z

Wohoo, thanks for confirming!

MonilBhavsar

Looks good! 🚀
Thanks all!

MonilBhavsar · 2023-11-16T14:24:09Z

Dismissed old PR reviewer checklist.
New one is here #25935 (comment)

OSBotify · 2023-11-16T14:28:36Z

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

rlinoz · 2023-11-21T13:08:33Z

This PR might have caused this regression, generating an adhoc build to check.

OSBotify · 2023-11-21T13:28:07Z

🧪🧪 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/25935/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/25935/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/25935/NewExpensify.dmg	https://25935.pr-testing.expensify.com

situchan · 2023-11-21T13:43:26Z

Potential regressions:

[$500] iOS - Conversation - Green line between the first and second new messages when returning online #31617
[$500] IOU - Unread marker does not appear above IOU preview when IOU is received #31621
[Paid] [$500] Chat - Unread message green line marker remains after opening the new message #31623

OSBotify · 2023-11-22T00:49:00Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

cubuspl42 · 2023-11-27T09:49:51Z

Is #31617 a regression of this PR?

rlinoz · 2023-11-27T21:29:38Z

From what I tested it potentially is, but I didn't actually revert this PR to check, just tested the Adhoc build.

arosiclair · 2024-07-19T20:07:59Z

src/pages/home/report/ReportActionsList.js

+// of the relevant reportActionID for displaying the green line.
+// We need to persist it across reports because there are at least 3 ReportScreen components created so the
+// internal states are resetted or recreated.
+const cacheUnreadMarkers = new Map();


@gedu @MonilBhavsar Hey I'm working on a bug related to unread markers and I'm having trouble wrapping my head around this cache. What problem/scenario does it fix specifically? Like is there a scenario where when we switch away from a report and then navigate back, we want the unread marker to persist?

gedu and others added 5 commits August 25, 2023 10:35

Updated logic to handle the shouldDisplayNewMarker

fab7506

Sending an event when the user mark as unread a message

47dd5cd

lint fixes

922fbf3

Merge branch 'main' into edu/23171_manually_unread_marking

85dddae

# Conflicts: # src/pages/home/report/ReportActionsList.js

Merge branch 'main' into edu/23171_manually_unread_marking

b9f1f17

# Conflicts: # src/pages/home/report/ReportActionsList.js

MonilBhavsar self-requested a review September 27, 2023 05:25

MonilBhavsar reviewed Sep 27, 2023

View reviewed changes

gedu added 4 commits September 27, 2023 08:00

Merge branch 'main' into edu/23171_manually_unread_marking

ec2e0fb

Listening to the specific reports and clearing unread marker cache

3646848

disable dependency hook, no need to listen to the messageManuallyMarked

c71ecae

Merge branch 'main' into edu/23171_manually_unread_marking

ebdeddb

# Conflicts: # src/pages/home/report/ReportActionsList.js

gedu marked this pull request as ready for review September 29, 2023 12:56

gedu requested a review from a team as a code owner September 29, 2023 12:56

melvin-bot bot requested review from allroundexperts and removed request for a team September 29, 2023 12:56

removed console logs

de5b8fe

mallenexpensify mentioned this pull request Oct 2, 2023

mWeb- Conversation- A green line appears for a second and disappears on receiving messages #28060

Closed

6 tasks

gedu added 2 commits October 3, 2023 09:02

Merge branch 'main' into edu/23171_manually_unread_marking

c483c10

# Conflicts: # src/pages/home/report/ReportActionsList.js

fixed lint issues

8925515

allroundexperts reviewed Oct 3, 2023

View reviewed changes

MonilBhavsar mentioned this pull request Oct 4, 2023

[Tracking] Redesign Unread Markers #15212

Closed

20 tasks

gedu added 2 commits October 9, 2023 10:50

Moved the DeviceEventEmitter into the markCommentAsUnread function

7149558

Merge branch 'main' into edu/23171_manually_unread_marking

89d15d2

# Conflicts: # src/pages/home/report/ReportActionsList.js

Merged main into edu/23171_manually_unread_marking

d1a347c

gedu added 2 commits November 16, 2023 14:55

Moved out the the prevReportID

0a578dd

commenting the new variable

8bb02a4

MonilBhavsar approved these changes Nov 16, 2023

View reviewed changes

Expensify deleted a comment from allroundexperts Nov 16, 2023

MonilBhavsar merged commit d220f6c into Expensify:main Nov 16, 2023
16 checks passed

This was referenced Nov 20, 2023

[Hold#15212][$500] Chat -The " new message" is not shown on top of the page after mark as unread an IOU #26760

Closed

[Hold #15212][$1000] Web - New marker does not go away when Report is automatically marked as read #21875

Closed

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

situchan mentioned this pull request Nov 21, 2023

[$500] iOS - Conversation - Green line between the first and second new messages when returning online #31617

Closed

6 tasks

rlinoz added the Ready To Build label Nov 21, 2023

MonilBhavsar mentioned this pull request Nov 21, 2023

[Paid] [$500] Chat - Unread message green line marker remains after opening the new message #31623

Closed

6 tasks

arosiclair reviewed Jul 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated logic to handle unread messages case #25935

Updated logic to handle unread messages case #25935

gedu commented Aug 25, 2023 •

edited by github-actions bot

Loading

MonilBhavsar left a comment

melvin-bot bot commented Sep 29, 2023

MonilBhavsar commented Oct 3, 2023

gedu commented Oct 3, 2023

allroundexperts commented Oct 3, 2023

allroundexperts Oct 3, 2023

gedu Oct 6, 2023

allroundexperts Oct 3, 2023

allroundexperts Oct 3, 2023

gedu Oct 6, 2023

gedu commented Oct 9, 2023

gedu commented Nov 15, 2023

shubham1206agra commented Nov 16, 2023

gedu commented Nov 16, 2023

gedu commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023 •

edited

Loading

MonilBhavsar commented Nov 16, 2023

MonilBhavsar commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023

MonilBhavsar commented Nov 16, 2023

MonilBhavsar left a comment •

edited

Loading

MonilBhavsar commented Nov 16, 2023

OSBotify commented Nov 16, 2023

rlinoz commented Nov 21, 2023

OSBotify commented Nov 21, 2023

situchan commented Nov 21, 2023

OSBotify commented Nov 22, 2023

cubuspl42 commented Nov 27, 2023

rlinoz commented Nov 27, 2023

arosiclair Jul 19, 2024

Updated logic to handle unread messages case #25935

Updated logic to handle unread messages case #25935

Conversation

gedu commented Aug 25, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MonilBhavsar left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 29, 2023

MonilBhavsar commented Oct 3, 2023

gedu commented Oct 3, 2023

allroundexperts commented Oct 3, 2023

allroundexperts Oct 3, 2023

Choose a reason for hiding this comment

gedu Oct 6, 2023

Choose a reason for hiding this comment

allroundexperts Oct 3, 2023

Choose a reason for hiding this comment

allroundexperts Oct 3, 2023

Choose a reason for hiding this comment

gedu Oct 6, 2023

Choose a reason for hiding this comment

gedu commented Oct 9, 2023

gedu commented Nov 15, 2023

shubham1206agra commented Nov 16, 2023

gedu commented Nov 16, 2023

gedu commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023 • edited Loading

MonilBhavsar commented Nov 16, 2023

MonilBhavsar commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023

MonilBhavsar commented Nov 16, 2023

MonilBhavsar left a comment • edited Loading

Choose a reason for hiding this comment

MonilBhavsar commented Nov 16, 2023

OSBotify commented Nov 16, 2023

rlinoz commented Nov 21, 2023

OSBotify commented Nov 21, 2023

situchan commented Nov 21, 2023

OSBotify commented Nov 22, 2023

cubuspl42 commented Nov 27, 2023

rlinoz commented Nov 27, 2023

arosiclair Jul 19, 2024

Choose a reason for hiding this comment

gedu commented Aug 25, 2023 •

edited by github-actions bot

Loading

shubham1206agra commented Nov 16, 2023 •

edited

Loading

MonilBhavsar left a comment •

edited

Loading