Sending a message scrolls down to previous message by rinej · Pull Request #54071 · Expensify/App

rinej · 2024-12-12T22:27:17Z

Explanation of Change

Problem:
Currently, when a user sends a message while positioned at the top of the chat, we scroll to the bottom, even if the newly sent message is not yet visible. This makes impression that we scroll to a previous message.

Solution:
In the PR we add behavior that the chat only scrolls to the bottom if the newly sent message is actually visible to the user.

Additional Consideration:
It's worth investigating the performance of message sending, particularly on Android, as there is noticeable lag during this operation. Addressing this could significantly improve the user experience.

Before Video:

OLD_behavior.mp4

After Video:

NEW_behavior.mp4

After merging newest main and conflicts resolution:

AndroidScroll.mp4

Fixed Issues

$ #53685
PROPOSAL: #53685 (comment)

Tests

Offline tests

QA Steps

Launch app on Android device
Open a chat with long chat history
Scroll to the top of the page
Send a message
Verify that the new message is visible

Additional tests for regular flow:

Launch app
Open a chat
Send a message
Verify that the new message is visible

PR Author Checklist

Screenshots/Videos

Android: Native

AndroidScroll.mp4

Android: mWeb Chrome

androidWeb.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

iOSWeb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-12-16T13:48:44Z

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

…essage

hoangzinh · 2024-12-23T15:43:30Z

                }
-                reportScrollManager.scrollToBottom();
-            });
+                Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report.reportID));


Just a question, do we have any case that needs to run this navigation runAfterInteractions?

It is to make sure that the scroll occurs after any high-priority interaction in the RN event loop, most likely animation, without it it can lead to some jerky animations or incomplete rendering.

It was already added in the code before that PR

Yeah, you're right. I mean previously, this navigation is put inside runAfterInteractions, but with our change, it's moved outside of runAfterInteractions. I'm checking if it's safe to move outside.

I tested it by hardcoding reportID to navigate to and I didn't see any issues. Here is an example video:

navigation.mp4

hoangzinh · 2024-12-23T15:43:33Z

+            // InteractionManager.runAfterInteractions(() => {
+            // If a new comment is added and it's from the current user scroll to the bottom otherwise leave the user positioned where
+            // they are now in the list.
+            if (!isFromCurrentUser || scrollingVerticalOffset.current === 0) {


I'm worrying whether if it causes any regression with this change scrollingVerticalOffset.current === 0, can you explain why do you like to add this new condition here?

It is just for early return, we first checks if the user is already scrolled to the bottom of the screen. If so, it immediately exits without executing any further logic and checks, cause we don't need perform scrolling in such scenario

hoangzinh · 2024-12-23T15:46:08Z

+                setPendingBottomScroll(false);
+            });
+        }
+    }, [pendingBottomScroll, prevSortedVisibleReportActionsObjects, reportScrollManager, isNewMessageDisplayed]);


should we change isNewMessageDisplayed to use useMemo, so we don't need to pass prevSortedVisibleReportActionsObjects here?

I replaced useCallback with useMemo, good point!

Because isNewMessageDisplayed will be updated if prevSortedVisibleReportActionsObjects is changed. Can we remove prevSortedVisibleReportActionsObjects out of dependency list here?

@rinej just in case you missed this

I just removed it :)

Perfect. Thank you @rinej

hoangzinh · 2024-12-23T15:54:24Z

Launch app in both mweb and app

@rinej can you elaborate why do we need to launch app in both mweb and app?

Also make sure that normal message sending flow is not broken

Can you explain this step too?

Btw, @rinej we should use "Verify" to determine expected behavior, it's described here. If it's possible, can you outline by 1,2,3 numbers? For example

Sign in to any account
Open a chat with long chat history
Scroll to the top of the page
...

…essage

rinej · 2025-01-02T13:39:15Z

@hoangzinh I updated the QA steps and the description. Please let me know if it is ok.
I also addressed the code's comments.

hoangzinh · 2025-01-02T15:30:47Z

Looks good @rinej. Can you change the testing step "See that the new message is visible" => "Verify that the new message is visible"? As it's described here

As such, the steps that should be proposed should contain the action element Verify and should be tied to the expected behavior in question.

rinej · 2025-01-02T15:56:46Z

Done 👍

hoangzinh · 2025-01-08T14:36:14Z

@rinej can you take a look at my feedback here https://github.com/Expensify/App/pull/54071/files#r1901572614?

rinej · 2025-01-09T13:52:40Z

I missed the update, thank you for the ping! I am on it

hoangzinh · 2025-01-09T14:58:02Z

@rinej please don't forget to upload recordings for all platforms

hoangzinh · 2025-01-09T23:36:47Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2025-01-21.at.17.41.53.mov

Android: mWeb Chrome

Screen.Recording.2025-01-20.at.22.10.34.android.chrome.mov

iOS: Native

Screen.Recording.2025-01-20.at.22.12.25.ios.mov

iOS: mWeb Safari

Screen.Recording.2025-01-20.at.21.55.26.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-20.at.21.44.00.web.mov

MacOS: Desktop

Screen.Recording.2025-01-20.at.21.48.51.desktop.mov

hoangzinh · 2025-01-09T23:45:10Z

@rinej sometime, it doesn't work on Web

Screen.Recording.2025-01-10.at.06.43.52.mov

rinej · 2025-01-10T13:35:27Z

Good spot, I couldn't reproduce it for a while, but finally I saw it. However it also happens on main, here is the recording from main branch, sometimes page starts to slightly shake and no scroll happens. So it looks like it comes from main. Could you confirm it?

I can investigate it further, cause this issues might be somehow related 🤔

scrollBlocksOnTop-main.mp4

hoangzinh · 2025-01-10T15:22:45Z

@rinej, I agree that it can be reproducible on the main. But let's fix it as our expectation is "Verify that the new message is visible", otherwise we probably can't pass QA test

…essage

hoangzinh · 2025-01-20T10:55:20Z

@rinej do you mind merging latest branch 'main' to fix Eslint failed?

…essage

rinej · 2025-01-20T11:41:09Z

Sure, Eslint should be fixed now

hoangzinh · 2025-01-20T14:40:01Z

+        const lastPrevAction = prevActions.at(0);
+        return lastAction?.reportActionID !== lastPrevAction?.reportActionID;


Suggested change

const lastPrevAction = prevActions.at(0);

return lastAction?.reportActionID !== lastPrevAction?.reportActionID;

const lastPrevVisibleAction = prevActions.at(0);

return lastAction?.reportActionID !== lastPrevVisibleAction?.reportActionID;

It's clearer if we name it like this. What do you think?

I like that change, makes it more descriptive. I just added it

hoangzinh · 2025-01-20T14:50:50Z

@rinej please also add recordings for remaining platforms (Android: mWeb Chrome, iOS: Native, iOS: mWeb Safari)

rinej · 2025-01-20T18:10:00Z

I updated the new recordings and added to all platforms

melvin-bot · 2025-01-21T10:45:06Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #53685 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2025-01-22T20:00:51Z

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

github-actions · 2025-01-23T18:27:02Z

🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.89-0 🚀

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

wildan-m · 2025-01-24T22:02:38Z

Possible regression:

https://expensify.slack.com/archives/C01GTK53T8Q/p1737755959458409

[CP Staging] Revert PR #54071

[CP Staging] Revert PR #54071 (cherry picked from commit f8cdd0d) (CP triggered by mountiny)

github-actions · 2025-01-28T01:50:27Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

mountiny · 2025-01-29T16:23:26Z

@rinej Noting this was also regression from this PR so #55693 please try to fix it in the follow up

rinej added 2 commits December 12, 2024 22:41

add logic to scrol when message appears

ea29168

adjust isNewMessageDisplayed

768c6d0

rinej mentioned this pull request Dec 16, 2024

[$250] Chat - Scrolling to top of page sending a message scrolls down to previous message #53685

Closed

8 tasks

rinej marked this pull request as ready for review December 16, 2024 13:48

rinej requested a review from a team as a code owner December 16, 2024 13:48

melvin-bot Bot requested review from hoangzinh and removed request for a team December 16, 2024 13:48

rinej added 4 commits December 18, 2024 16:22

Merge branch 'main' into Sending-a-message-scrolls-down-to-previous-m…

93b5320

…essage

changes after main merge

99f3502

adjust after mergin main

925a3e0

adjust to new eslint rules

273498a

hoangzinh reviewed Dec 23, 2024

View reviewed changes

rinej added 2 commits January 2, 2025 12:16

Merge branch 'main' into Sending-a-message-scrolls-down-to-previous-m…

c97a850

…essage

refactor useCallstack to useMemo

a6a79d7

rinej requested a review from hoangzinh January 8, 2025 11:39

remove unnecessery useEffect deps

37b1e7b

Merge branch 'main' into Sending-a-message-scrolls-down-to-previous-m…

e3cf125

…essage

Merge branch 'main' into Sending-a-message-scrolls-down-to-previous-m…

d122060

…essage

hoangzinh reviewed Jan 20, 2025

View reviewed changes

rename variable to be more descriptive

929a4f8

hoangzinh approved these changes Jan 21, 2025

View reviewed changes

melvin-bot Bot requested a review from deetergp January 21, 2025 10:46

deetergp approved these changes Jan 22, 2025

View reviewed changes

deetergp merged commit 76d187f into Expensify:main Jan 22, 2025

github-actions Bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

wildan-m mentioned this pull request Jan 24, 2025

[Due for payment 2025-02-19] [$250] Android - Chat - Chat is not autoscrolled when sending new message after opened from search. #52878

Closed

8 tasks

rlinoz mentioned this pull request Jan 24, 2025

Chat does not scroll to the bottom when submitting expenses while being at the top of the chat #55693

Closed

8 tasks

bernhardoj mentioned this pull request Jan 24, 2025

Fix chat doesn't scroll when splitting expense #54863

Merged

50 tasks

m-natarajan mentioned this pull request Jan 27, 2025

[HOLD for payment 2025-02-05] [HOLD for payment 2025-02-04] Not auto scrolled when send another chat after reload from last chat #55780

Closed

8 tasks

amyevans mentioned this pull request Jan 27, 2025

[CP Staging] Revert PR #54071 #55790

Merged

50 tasks

amyevans added a commit that referenced this pull request Jan 27, 2025

Merge pull request #55790 from Expensify/amy-revert-auto-scroll

f8cdd0d

[CP Staging] Revert PR #54071

OSBotify pushed a commit that referenced this pull request Jan 27, 2025

Merge pull request #55790 from Expensify/amy-revert-auto-scroll

0a211a2

[CP Staging] Revert PR #54071 (cherry picked from commit f8cdd0d) (CP triggered by mountiny)

		const lastPrevAction = prevActions.at(0);
		return lastAction?.reportActionID !== lastPrevAction?.reportActionID;

Conversation

rinej commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Dec 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Dec 23, 2024

Uh oh!

rinej commented Jan 2, 2025

Uh oh!

hoangzinh commented Jan 2, 2025

Uh oh!

rinej commented Jan 2, 2025

Uh oh!

hoangzinh commented Jan 8, 2025

Uh oh!

rinej commented Jan 9, 2025

Uh oh!

hoangzinh commented Jan 9, 2025

Uh oh!

hoangzinh commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hoangzinh commented Jan 9, 2025

Uh oh!

rinej commented Jan 10, 2025

Uh oh!

hoangzinh commented Jan 10, 2025

Uh oh!

hoangzinh commented Jan 20, 2025

Uh oh!

rinej commented Jan 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Jan 20, 2025

Uh oh!

rinej commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melvin-bot Bot commented Jan 21, 2025

Uh oh!

OSBotify commented Jan 22, 2025

Uh oh!

github-actions Bot commented Jan 23, 2025

rinej commented Dec 12, 2024 •

edited

Loading

hoangzinh commented Jan 9, 2025 •

edited

Loading

rinej commented Jan 20, 2025 •

edited

Loading