Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sending a message scrolls down to previous message #54071

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Sending a message scrolls down to previous message #54071

wants to merge 6 commits into from

Conversation

rinej
Copy link
Contributor

@rinej rinej commented Dec 12, 2024 •
edited
Loading

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 in both mweb and app

  • Open a chat with long chat history

  • Scroll to the top of the page

  • Send a message

  • See that the new message is visible

  • Also make sure that normal message sending flow is not broken

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
AndroidScroll.mp4
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@rinej rinej mentioned this pull request Dec 16, 2024
Open
8 tasks
@rinej rinej marked this pull request as ready for review December 16, 2024 13:48
@rinej rinej requested a review from a team as a code owner December 16, 2024 13:48
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team December 16, 2024 13:48
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Dec 16, 2024

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

hoangzinh
hoangzinh reviewed Dec 23, 2024
View reviewed changes
src/pages/home/report/ReportActionsList.tsx
return;
}
reportScrollManager.scrollToBottom();
});
Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report.reportID));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

src/pages/home/report/ReportActionsList.tsx
// 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) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

src/pages/home/report/ReportActionsList.tsx
setPendingBottomScroll(false);
});
}
}, [pendingBottomScroll, prevSortedVisibleReportActionsObjects, reportScrollManager, isNewMessageDisplayed]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@hoangzinh
Copy link
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hoangzinh hoangzinh hoangzinh left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rinej @hoangzinh