Chat loader flickering #32124

perunt · 2023-11-28T14:13:24Z

Issue: The onStartReached function is being triggered more frequently than necessary. It leads to the loader flickering

When onStartReached is Necessary:

Navigating to Comments: It's crucial for loading newer report actions when users navigate to comments through links.
Returning from Offline Mode: It's important for catching up on messages missed while offline, especially when there's a significant backlog.

Solution:
Introduce isNewestReportAction Flag: This flag will be attached to the most recent report actions. It serves as an indicator to decide whether to call onStartReached.

Application in Comment Linking: When using comment links, we'll isolate a specific array of reports from Onyx for the user. If the first item (the newest in an inverted list) has the isNewestReportAction flag, it signifies that triggering onStartReached is not required.
Handling Offline Scenarios: Upon reconnection, the true latest report action is obtained from OpenReport and marked by us with isNewestReportAction. This helps determine the necessity of onStartReached.

Our goal is to reduce redundant data fetching, thereby improving efficiency and the user experience. This is especially crucial in handling large volumes of messages and in scenarios involving reconnection after being offline.

Details

Fixed Issues

$ #30729 (comment)
#30495 (comment)
PROPOSAL:

Tests

Open a chat and check the bottom loader, you shouldn't see it.
Scroll to the top and bottom to check if it appears.
Send messages.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

telegram-cloud-document-2-5420290165396487348.mp4

Android: mWeb Chrome

iOS: Native

Nov-29-2023.09-43-18.mp4

iOS: mWeb Safari

Nov-29-2023.09-47-02.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-11-29.at.09.29.36.mov

Untitled480.mov

MacOS: Desktop

Untitled.2.mov

melvin-bot · 2023-11-28T16:11:59Z

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

abdulrahuman5196 · 2023-11-28T18:28:32Z

Hi @perunt Unit tests are failing in this PR, seems to be related to this PR? Could you kindly check on the same?

And screenshots are also not added yet. Kindly let me know if UI changes won't be visible for the PR as well.

perunt · 2023-11-29T09:01:54Z

@abdulrahuman5196 done

abdulrahuman5196 · 2023-11-29T17:53:24Z

Thank you. Will take a look in my morning.

Also the author's checklist is not complete yet. Kindly take a look into that as well. @perunt

perunt · 2023-12-04T12:15:25Z

@abdulrahuman5196, how's it going?

abdulrahuman5196 · 2023-12-04T12:34:41Z

Hi, Rechecking now.

abdulrahuman5196 · 2023-12-04T19:01:03Z

src/pages/home/report/ReportActionsView.js

@@ -199,7 +200,7 @@ function ReportActionsView(props) {
    const loadNewerChats = useMemo(
        () =>
            _.throttle(({distanceFromStart}) => {
-                if (props.isLoadingNewerReportActions || props.isLoadingInitialReportActions) {
+                if (props.isLoadingNewerReportActions || props.isLoadingInitialReportActions || isNewestReportAction) {


It seems like this isNewestReportAction will most likely always be true. Since as soon as we have the actions for display, we are setting the first report action to have isNewestReportAction: true and checking the same here.

When can this value be false, so that we will loadNewerChats function will fetch new data?

I am not sure if I had understood clearly, kindly clarify if I misunderstood.

@perunt

Before all, we must remember that we cannot show some specific range of reportActions in the list. We constantly mix them all and sort them. Comment linking brings the ability to cut sequences chank of sorted messages and will help not to include missed places.
Firstly, we need to figure out when we need to fetch new report actions. Answer - when we locate not on the end of the list. What I mean:

when you were offline and received 1000 report actions. Once you return online, call OpenReport and get the latest 50 reportAction. So your last message, the latest before moving offline now, is different.
You have current report action -> gap with 950 items -> the latest 50 elements. In this case, we need to fetch new items when we reach that gap with 950 el

the same stuff for comment linking. Once we were navigated to the middle of a chat, we should be able to fetch a newer report action when scrolling down

In the rest cases, we do not need this functionality since Pusher keeps this up-to-date.

Discussed with @perunt Offline and it seems for now isNewestReportAction will be rarely false. As part next sequent PRs loadNewerChats will be further updated to fullest extent.

perunt · 2023-12-06T07:30:11Z

@abdulrahuman5196 you can also use test steps from this PR

abdulrahuman5196 · 2023-12-06T08:23:50Z

Checking now again

perunt · 2023-12-06T15:45:46Z

@abdulrahuman5196, was it successful?

abdulrahuman5196 · 2023-12-06T15:46:38Z

Hi @perunt working on it. Will close out in an hour.

abdulrahuman5196 · 2023-12-06T16:56:34Z

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 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 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-06.at.10.14.04.PM.mp4

Android: mWeb Chrome

Screen.Recording.2023-12-06.at.10.20.01.PM.mp4

iOS: Native

Screen.Recording.2023-12-06.at.10.07.19.PM.mp4

iOS: mWeb Safari

Screen.Recording.2023-12-06.at.10.10.20.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-12-06.at.9.58.11.PM.mp4

MacOS: Desktop

Screen.Recording.2023-12-06.at.10.01.58.PM.mp4

abdulrahuman5196 · 2023-12-06T17:00:00Z

Note: Regarding the other issue linked - #30495 , the loader doesn't appear wrongly. But the page flicker happens at sometime in Android/native , but it could be related to other performance factors as well.

cc: @perunt

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @roryabraham

🎀 👀 🎀
C+ Reviewed

src/pages/home/report/ReportActionsView.js

OSBotify · 2023-12-06T17:53:37Z

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

OSBotify · 2023-12-06T22:17:58Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-06T23:12:09Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-08T01:09:16Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.9-5 🚀

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

perunt added 4 commits November 28, 2023 15:00

mark the first item in getSortedReportActions

d15cd01

update type ReportActionBase

c476637

use isNewestReportAction for loadNewerChats

69223ca

fix types

683aa4e

perunt marked this pull request as ready for review November 28, 2023 16:11

perunt requested a review from a team as a code owner November 28, 2023 16:11

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team November 28, 2023 16:11

perunt mentioned this pull request Nov 28, 2023

HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

Merged

50 tasks

perunt added 4 commits November 29, 2023 08:07

tests

2c70241

update getSortedReportActionsForDisplay

5bd1314

update test

ff1c9f3

lint

e6b6ed8

abdulrahuman5196 suggested changes Dec 4, 2023

View reviewed changes

roryabraham self-requested a review December 5, 2023 16:18

janicduplessis mentioned this pull request Dec 5, 2023

[HOLD PR #32124] Spinner appears at the bottom when scroll up 1/2 of the page and scroll back down #32462

Closed

6 tasks

abdulrahuman5196 approved these changes Dec 6, 2023

View reviewed changes

roryabraham requested changes Dec 6, 2023

View reviewed changes

src/pages/home/report/ReportActionsView.js Outdated Show resolved Hide resolved

update naming

cc68278

roryabraham approved these changes Dec 6, 2023

View reviewed changes

roryabraham merged commit 5681090 into Expensify:main Dec 6, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 6, 2023

Deploy Checklist: New Expensify 2023-12-06 #32589

Closed

74 tasks

melvin-bot bot mentioned this pull request Dec 8, 2023

[HOLD for payment 2023-12-15] [$500] IOS - A spinner appears in the chat when a message is posted #30729

Closed

6 tasks

sobitneupane mentioned this pull request Dec 8, 2023

[$500] Chat - The chat shakes when you swipe down #31586

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chat loader flickering #32124

Chat loader flickering #32124

perunt commented Nov 28, 2023 •

edited

Loading

melvin-bot bot commented Nov 28, 2023

abdulrahuman5196 commented Nov 28, 2023 •

edited

Loading

perunt commented Nov 29, 2023

abdulrahuman5196 commented Nov 29, 2023

perunt commented Dec 4, 2023

abdulrahuman5196 commented Dec 4, 2023

abdulrahuman5196 Dec 4, 2023

perunt Dec 5, 2023

abdulrahuman5196 Dec 6, 2023

perunt commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023

perunt commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023 •

edited

Loading

abdulrahuman5196 commented Dec 6, 2023

abdulrahuman5196 left a comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

Chat loader flickering #32124

Chat loader flickering #32124

Conversation

perunt commented Nov 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 28, 2023

abdulrahuman5196 commented Nov 28, 2023 • edited Loading

perunt commented Nov 29, 2023

abdulrahuman5196 commented Nov 29, 2023

perunt commented Dec 4, 2023

abdulrahuman5196 commented Dec 4, 2023

abdulrahuman5196 Dec 4, 2023

Choose a reason for hiding this comment

perunt Dec 5, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Dec 6, 2023

Choose a reason for hiding this comment

perunt commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023

perunt commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023

abdulrahuman5196 commented Dec 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 commented Dec 6, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

perunt commented Nov 28, 2023 •

edited

Loading

abdulrahuman5196 commented Nov 28, 2023 •

edited

Loading

abdulrahuman5196 commented Dec 6, 2023 •

edited

Loading