[HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker #42217

ikevin127 · 2024-05-15T20:42:10Z

Details

We need a new useEffect within the ReportActionsList component which will scrollToUnreadMessageIndex when we open the report which has lots of unread messages (going out of messages initial view), using the DeviceEventEmitter listener.

To do this we modified our existing reportScrollManager.scrollToIndex function to optionally take in the viewPosition argument because we're inverting the flatlist which means that we would need to pass viewPosition: 1 to the FlatList's scrollToIndex function such that we are scrolling to the top of the new message (unread marker).

Fixed Issues

$ #35011
PROPOSAL: #35011 (comment)

Tests

User A and User B have started a chat.
(important) User A navigates away from chat report with User B by clicking on any other report in LHN.
As User B, send a good number of messages to chat report with User A, enough new messages that can be scrolled up and down, meaning the new unread marker would be outside (higher up) the initial view range when the report is opened.
As user A, open the chat report with User B from LHN.
Notice how upon opening the chat, the view is scrolled to the top of the new unread message marker.

Additionally, make sure these issues are not reproducible while testing:

[HOLD for payment 2024-05-22] Chat - After marking a message as unread, sending a new message causes the chat to scroll up #42100
Chat - App fails to scroll chat to the first unread message in offline mode #42148
making sure any other previously existing report scrolling functionality will not be affected by this solution
Verify that no errors appear in the JS console

Offline tests

TLDR: same as Tests.

User A and User B have started a chat.
(important) User A navigates away from chat report with User B by clicking on any other report in LHN.
As User B, send a good number of messages to chat report with User A, enough new messages that can be scrolled up and down, meaning the new unread marker would be outside (higher up) the initial view range when the report is opened.
As user A, open the chat report with User B from LHN.
Notice how upon opening the chat, the view is scrolled to the top of the new unread message marker.

QA Steps

TLDR: same as Tests.

User A and User B have started a chat.
(important) User A navigates away from chat report with User B by clicking on any other report in LHN.
As User B, send a good number of messages to chat report with User A, enough new messages that can be scrolled up and down, meaning the new unread marker would be outside (higher up) the initial view range when the report is opened.
As user A, open the chat report with User B from LHN.
Notice how upon opening the chat, the view is scrolled to the top of the new unread message marker.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mp4

…read message marker

melvin-bot · 2024-05-15T20:42:15Z

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

…11-2

ikevin127 · 2024-05-28T21:31:08Z

@mollfpr This has been ready for review for the past 2 weeks. Note: just synced w/ main to resolve conflicts.

mollfpr · 2024-05-29T02:06:20Z

Sorry for the delay 🙏

I'll finish the review today.

ikevin127 · 2024-06-04T22:02:15Z

When testing this, we have to make sure these issues are not reproducible:

[HOLD for payment 2024-05-22] Chat - After marking a message as unread, sending a new message causes the chat to scroll up #42100
Chat - App fails to scroll chat to the first unread message in offline mode #42148
making sure any other previously existing report scrolling functionality will not be affected by this solution

in order to avoid any other regressions which could lead to PR revert again 🤞

mollfpr · 2024-06-07T17:20:47Z

Posted here to get other c+ take over.

ishpaul777 · 2024-06-07T18:09:15Z

@ikevin127 you have conflicts..

…11-2

ikevin127 · 2024-06-07T18:24:39Z

@ishpaul777 Solved, ready for review!

ishpaul777

Only minor comments testing is ongoing..

ishpaul777 · 2024-06-07T20:19:28Z

src/hooks/useReportScrollManager/types.ts

@@ -2,7 +2,14 @@ import type {FlatListRefType} from '@pages/home/ReportScreenContext';

 type ReportScrollManagerData = {
    ref: FlatListRefType;


lets add a comment for ref also ?

ishpaul777 · 2024-06-07T20:25:12Z

src/pages/home/report/ReportActionsList.tsx

@@ -514,6 +514,45 @@ function ReportActionsList({
        calculateUnreadMarker();
    }, [calculateUnreadMarker, report.lastReadTime, messageManuallyMarkedUnread]);

+    function onItemLayout(index: number) {
+        return () => DeviceEventEmitter.emit('renderedItemIndex', index);


lets use a constant for renderedItemIndex

ishpaul777 · 2024-06-08T16:08:58Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

Screen.Recording.2024-06-08.at.2.21.53.AM-1.mov

MacOS: Desktop

ishpaul777 · 2024-06-08T16:53:41Z

There's a bug on main ios which prevents me testing for this issue. New line marker hides immediately when opening a unread chat.

Steps:

Open the app.
Got to LHN.
Send a message from USER A to USER B.
Open the chat with User B on device 2.
Observe that the new marker hides immediately.

Screen.Recording.2024-06-08.at.10.01.28.PM-1.mov

ikevin127 · 2024-06-08T18:45:55Z

@ishpaul777 You're saying this bug is on main or only on this PR ?

If it is on main (not related to this PR), there's another thing you can do on any platform to test this.

For example on iOS: Native:

Go to a chat with lots of messages.
Scroll up to a message that's up out of the scroll view.
Mark it as unread.
Navigate back from the report to LHN (the report should show as unread).
Navigate to the report and this PR'a functionality should scroll you to the new unread message marker if this is present.

Note: Not sure if this will work regardless of the main bug mentioned, but it should since you are marking as unread from the client-side instead of BE doing it.

I will to confirm whether this bug is on main or caused by the PR.

ishpaul777 · 2024-06-08T18:56:58Z

I verified that this is also reproducable on main, so might not be related to this PR

ishpaul777 · 2024-06-08T19:26:31Z

nvm, the bug i mentioned is only for new messages the alternative steps works.

ishpaul777 · 2024-06-08T19:35:09Z

Our logic depends on whether the Message is rendered in the Flatlist, but it fails in case unread message is not in first batch of rendering then user scroll to top only when the message is rendered, i wont say this is bug but still a weird behavior from user perspective Wdyt? @ikevin127

Screen.Recording.2024-06-09.at.12.57.21.AM.mov

ikevin127 · 2024-06-08T20:13:11Z

@ishpaul777 Good catch! It's true that if you open a report for the first time (after app is opened), there's a certain batch that's going to be rendered (128-168) messages depending on the platform / screen size (initialNumToRender calculation) and more messages are going to render if you scroll up manually.

But in the real world there could be a case where say a user is invited to a report and they actually login into the app at a later point where people already sent 200+ messages, case in which this functionality won't work in scrolling to the unread message marker since this is not rendered yet.

What I can try and do to have this functionality work as expected regardless of the index of the unread message within a report is:

if there is a unreadMessageIndex detected but it's not found within the initial batch -> programatically scroll up in the list until the unread message index is detected within the rendered batch -> then the scrollToUnreadMessageIndex listener function is going to pick it up from there and scroll to it

This would look good from a UI/UX perspective and would be fool-proof functionality wise. I'll put this on HOLD until I test / implement this idea and will let you know if it's doable and works as expected.

ikevin127 · 2024-06-11T01:23:23Z

@ishpaul777 I tried to implement the functionality proposed in my previous comment but it doesn't work because of the way our current logic works:

when user login and navigates to a report with 200+ messages, the OpenReport only gets about ~168 actions in the initial call when the report is opened
if the user scrolls up in the report to see previous messages, we call GetOlderActions which gets the next 100 some actions

Given this, there's no way to automatically scroll past the first batch given the current logic because the currentUnreadMarker will not be found if this is not within the first batch which we have if we already opened the report. Also there's an additional issue where if the user opens a report with a lot of messages right after a fresh login, the currentUnreadMarker will also not be found.

So this PR's logic only works when a user already opened the report, they received some new messages and they open the report again - which defeats the purpose of this NewFeature since this should work in all the following conditions:

When the user does a fresh login and navigates to a report with unread messages that has 200-300+ new messages.
When the user performs browser refresh and navigates to a report with unread messages that has 200-300+ new messages.
When the user already opened a report, then opens another report and meanwhile the initial report has unread messages with 200-300+ new messages.

The current PR achieves none of these 3, but only a reduced version of number (3.), therefore I will close it and call it quits since this is above my level of technicality given the current app logic.

cc @yuwenmemon @trjExpensify

[NewFeature-Rework] Automatic scrolling to the top of report's new un…

e45e32e

…read message marker

ikevin127 requested a review from a team as a code owner May 15, 2024 20:42

melvin-bot bot requested review from mollfpr and removed request for a team May 15, 2024 20:42

ikevin127 mentioned this pull request May 15, 2024

[$1000] Jump to last unread chat when opening a report #35011

Open

6 tasks

ikevin127 added 2 commits May 28, 2024 13:59

Merge branch 'main' of https://github.com/Expensify/App into feat/350…

0e79dae

…11-2

Merge branch 'main' of https://github.com/Expensify/App into feat/350…

64d3034

…11-2

ikevin127 added 2 commits June 7, 2024 11:23

Merge branch 'main' of https://github.com/Expensify/App into feat/350…

7356497

…11-2

prettier

4f30537

ishpaul777 reviewed Jun 7, 2024

View reviewed changes

minor code-review changes

0034e23

This comment was marked as outdated.

Sign in to view

ikevin127 changed the title ~~[NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker~~ [HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker Jun 9, 2024

ikevin127 closed this Jun 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker #42217

[HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker #42217

ikevin127 commented May 15, 2024

melvin-bot bot commented May 15, 2024

ikevin127 commented May 28, 2024

mollfpr commented May 29, 2024

ikevin127 commented Jun 4, 2024 •

edited

Loading

mollfpr commented Jun 7, 2024

ishpaul777 commented Jun 7, 2024

ikevin127 commented Jun 7, 2024

ishpaul777 left a comment •

edited

Loading

ishpaul777 Jun 7, 2024

ishpaul777 Jun 7, 2024

ishpaul777 commented Jun 8, 2024 •

edited

Loading

ishpaul777 commented Jun 8, 2024

ikevin127 commented Jun 8, 2024 •

edited

Loading

This comment was marked as outdated.

ishpaul777 commented Jun 8, 2024

ishpaul777 commented Jun 8, 2024

ishpaul777 commented Jun 8, 2024 •

edited

Loading

ikevin127 commented Jun 8, 2024 •

edited

Loading

ikevin127 commented Jun 11, 2024

		@@ -2,7 +2,14 @@ import type {FlatListRefType} from '@pages/home/ReportScreenContext';

		type ReportScrollManagerData = {
		ref: FlatListRefType;

[HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker #42217

[HOLD - Functionality][NewFeature-Rework] Automatic scrolling to the top of report's new unread message marker #42217

Conversation

ikevin127 commented May 15, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 15, 2024

ikevin127 commented May 28, 2024

mollfpr commented May 29, 2024

ikevin127 commented Jun 4, 2024 • edited Loading

mollfpr commented Jun 7, 2024

ishpaul777 commented Jun 7, 2024

ikevin127 commented Jun 7, 2024

ishpaul777 left a comment • edited Loading

Choose a reason for hiding this comment

ishpaul777 Jun 7, 2024

Choose a reason for hiding this comment

ishpaul777 Jun 7, 2024

Choose a reason for hiding this comment

ishpaul777 commented Jun 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented Jun 8, 2024

ikevin127 commented Jun 8, 2024 • edited Loading

This comment was marked as outdated.

ishpaul777 commented Jun 8, 2024

ishpaul777 commented Jun 8, 2024

ishpaul777 commented Jun 8, 2024 • edited Loading

ikevin127 commented Jun 8, 2024 • edited Loading

ikevin127 commented Jun 11, 2024

ikevin127 commented Jun 4, 2024 •

edited

Loading

ishpaul777 left a comment •

edited

Loading

ishpaul777 commented Jun 8, 2024 •

edited

Loading

ikevin127 commented Jun 8, 2024 •

edited

Loading

ishpaul777 commented Jun 8, 2024 •

edited

Loading

ikevin127 commented Jun 8, 2024 •

edited

Loading