Refactor code to improve unread marker logic

[gedu]

Details

• Migrates Unread Marker logic from ReportActionsView to ReportActionsList component
• Improves the unread marker logic by using hooks

Fixed Issues

$ #23171
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Have two users A and B

Active chat case

1. As a user A, open chat with user B and as user B open chat with user A in different tabs
2. Send a message as a user A to user B
3. Ensure no marker is displayed to user A and user B

Inactive chat case

1. As a user A, open chat with user B and as user B open chat other than user A in different tabs
2. Send a message as a user A to user B
3. Ensure no marker is displayed to user A but user B sees new marker above new messages

Mark as unread

1. As a user B, mark any message as unread from user A
2. Verify new marker appears above it
3. Go to any other chat and come back to chat with user A
4. Verify marker still appears
5. Go to any other chat and come back to chat with user A
6. Verify marker is not visible now

Deleting a message

1. As a user A, open chat with user B and as user B open chat other than user A in different tabs
2. Send two message as a user A to user B
3. Ensure no marker is displayed to user A but user B sees new marker above new messages
4. As a user A, delete message
5. As user B, ensure new marker line is there and message is deleted
6. As a user A, delete another message
7. As user B, ensure new marker line and message are deleted

Scrolled up

1. As a user A, open chat with user B and as user B open chat other than user A in different tabs
2. Send a message as a user A to user B
3. Ensure no marker is displayed to user A but user B sees new marker above new messages
4. Scroll up and ensure you see a floating button
5. Click on it and ensure you're taken down

• Verify that no errors appear in the JS console

Offline tests

None, same as online(As message sending and receiving is halt when offline)

QA Steps

Please see Tests

• 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
  • 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(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 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

unreadMarker_chrome.mp4

unreadMarker_safari.mp4

Mobile Web - Chrome

Mobile Web - Safari

unreadMarker_iosSafari.mp4

Desktop

unreadMarker_desktop.mp4

iOS

unreadMarker_ios.mp4

Android

unreadMarker_android.mp4

[MonilBhavsar]

I have updated base branch so we stay up to date with main

[allroundexperts]

@MonilBhavsar Can you confirm if this is fixed on your side as well?

[allroundexperts]

This tests well from my side. Thanks @MonilBhavsar and @gedu for your patience!

[MonilBhavsar]

Thanks! I can verify on my side

[MonilBhavsar]

Confirmed! works for me too
https://drive.google.com/file/d/1HnXkqPt5VKGt0UB2A6dOPnd3UByjDPIf/view?usp=drive_link

[MonilBhavsar]

Let's ship it!! 🚀

[OSBotify]

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

[Pujan92]

@gedu I think we should unsubscribe the typing event in the ReportActionsView on unmount instead of keeping it open or restricting multiple subscriptions for the same channel.
https://github.com/Expensify/App/pull/18637/files#diff-3d3d60df30d1761a83ff8413b06ecef63fcd0084053cd70d5686098e71d87362L184

Need to create cleanup function here which calls Report.unsubscribeFromReportChannel(reportID);

App/src/pages/home/report/ReportActionsView.js

Lines 86 to 89 in c435734

	useEffect(() => {
	openReportIfNecessary();
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []);

[gedu]

@gedu I think we should unsubscribe the typing event in the ReportActionsView on unmount instead of keeping it open or restricting multiple subscriptions for the same channel. https://github.com/Expensify/App/pull/18637/files#diff-3d3d60df30d1761a83ff8413b06ecef63fcd0084053cd70d5686098e71d87362L184

Need to create cleanup function here which calls Report.unsubscribeFromReportChannel(reportID);

App/src/pages/home/report/ReportActionsView.js

Lines 86 to 89 in c435734

	useEffect(() => {
	openReportIfNecessary();
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []);

Hey, the next useEffect runs the unsubscribeFromReportChannel.
All those flows, weren't part of unread marker refactor, come from so many merges

[hayata-suenaga]

@gedu could you check if this issue was caused by this PR?

[OSBotify]

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.56-0 🚀

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

[dukenv0307]

@MonilBhavsar Actually, canDisplayMarker is wrong whenever we create a new action and mask as unread this action. That makes currentUnreadMarker isn't updated correctly. The reason is the newest action has reportAction.created is always bigger userActiveSince.current.

Screencast.from.22-08-2023.17.26.27.webm

[roryabraham]

Evaluating the deploy blockers related to this PR, it seems there are three:

• Web - New line marker on Task does not disappear when sending or receiving a message #25776 Edit: This one was expected behavior
• Chat - New marker displayed briefly when chat is opened #25673
• [HOLD for payment 2023-09-04] Greenline line doesn't appear after the mark of a message as unread (iOS) #25737 Edit: This one was unrelated

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

[mollfpr]

Hi, coming from #26432

The issue is a regression from this removed, where the current user doesn't scroll to the bottom after sending a message.

I have several questions regarding these changes:

1. Are the current users not scrolled to the bottom after sending a message is expected?
2. If not, can we reintegrate the listener Report.subscribeToNewActionEvent to scroll the current user when sending a message? Or there's a performance consideration to use that listener.

cc @gedu @MonilBhavsar @allroundexperts

[MonilBhavsar]

Are the above results expected?

Sorry, what result?

[mollfpr]

Ahh, sorry for not making it clear.

Sorry, what result?

The current user doesn't scroll to the bottom after sending a message when they're not at the bottom of the chat.

[MonilBhavsar]

That does seem like issue. We should definitely scroll user to the bottom

[mollfpr]

@MonilBhavsar Is there any drawback or performance issue if we use Report.subscribeToNewActionEvent to get the current report action?

[gedu]

I don't think it will have an impact on performance, it will be mainly just to know when a new message is sent. Because this newActionEvent only listens to comments sent, and not received from others.