Move logic to start report actions list at index to BaseInvertedFlatList #52149

janicduplessis · 2024-11-06T22:27:24Z

Explanation of Change

This PR is the first step towards being able to open chats at the last unread message. We currently have some logic to open a chat at a specific message for comment linking, but this code is heavily coupled with the comment linking code and ReportActionsView. This moves the logic that allows the list to open at a specific index to BaseInvertedFlatList which will make it easy to reuse for opening chat at last unread also.

FlatList has a initialScrollIndex prop, but it doesn't work very well, it also doesn't work at all if the index is too big and is not rendered initially. To avoid this problem we implemented a workaround in the comment linking code. What we do is render the list initially from the initial index we want and progressively add items before it in onStartReached.

This code can actually be completely decoupled from the comment linking logic and just make the initialScrollIndex prop of BaseInvertedFlatList use that same logic. This is what this PR does.

Fixed Issues

$ #35011
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Tested comment linking flows described in QA Steps

Offline tests

QA Steps

Test common comment linking flows (testing steps taken from Client side pagination gap detection #41962). Note that there should be no behaviour changes from main. If you find something that looks like a bug, please make sure it does not happen on main.

Test 1: Basic Navigation

Create a chat between Account A and Account B.
Send 200 messages from Account A to Account B.
Copy the link to the 70th message and send it to Account B (first link).
Copy the link to the 150th message and send it to Account B (second link).
From Account A, click on the first link. Verify redirection to the exact message.
From Account A, click on the second link. Verify redirection to the exact message.
From Account B, click on the first link. Verify redirection to the exact message.
From Account B, click on the second link. Verify redirection to the exact message.

Note: Links can be copied to any message and used in any order.

Test 2: Popup Navigation

Continue using the chat from Test 1.
From Account A, click on the first link. Verify redirection to the exact message.
After redirection, a popup should appear at the top of the screen (similar to new message popup).
Click on this popup.
Verify navigation to the end of the list (newest messages).

Test 3: Cache and Logout

Logout from the accounts and clear the cache.
Log back in.
From Account A, click on the first link. Verify redirection to the exact message.
From Account A, click on the second link. Verify redirection to the exact message.
From Account B, click on the first link. Verify redirection to the exact message.
From Account B, click on the second link. Verify redirection to the exact message.

Test 4:

Create a workspace as User A.
Invite User B.
Navigate to the created Workspace Chat as User B.
Observe User B has a whisper message.
Send a few messagse as User B inside the workspace chat.
Navigate to Chat as User A.
Observe User A does not see any whisper messages nor have them in their Onyx data.
User A should see the previous actions

Notes:
Ensure the chat contains at least 150 messages. Initially, up to 50 messages are rendered. Navigating to the 70th message should allow further navigation up to the 150th message, even with gaps.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-06.at.20.25.35.mov

Android: mWeb Chrome

Screen.Recording.2024-11-06.at.20.41.28.mov

iOS: Native

Screen.Recording.2024-11-06.at.20.24.18.mov

iOS: mWeb Safari

Screen.Recording.2024-11-06.at.20.49.38.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-06.at.19.13.27.mov

MacOS: Desktop

Screen.Recording.2024-11-06.at.19.45.38.mov

melvin-bot · 2024-11-07T01:52:03Z

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

janicduplessis · 2024-11-07T01:55:20Z

As you can see in the videos there seems to be a lot of jumping going on after comment linking on native platforms (ios / android). It also happens on main so it is not related to this change. I will try to take some time soon to investigate those, especially important since we're going to use that case more now if opening at last unread.

rlinoz · 2024-11-08T18:19:49Z

I think we are cutting some messages when opening a link to a message, maybe it happens if the newer messages are already loaded?

Screen.Recording.2024-11-08.at.15.17.53.mov

janicduplessis · 2024-11-12T15:00:29Z

@rlinoz Are you able to consistently reproduce? I am trying the same thing as the video, but the messages do load.

This is with messages already in cache.

ishpaul777 · 2024-11-12T20:22:04Z

Its on my radar, i'll review try to review this sometime tmrw 🙇

rlinoz · 2024-11-14T16:38:08Z

@ishpaul777 friendly bump

Are you able to consistently reproduce?

I will check again and try to get better steps

ishpaul777 · 2024-11-17T14:19:29Z

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.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

Screen.Recording.2024-12-15.at.1.53.29.AM-1-1.mov

Android: mWeb Chrome

Screen.Recording.2024-12-15.at.2.07.31.AM.mov

iOS: Native

Screen.Recording.2024-12-15.at.1.14.40.AM-1.mov

iOS: mWeb Safari

Screen.Recording.2024-12-15.at.1.23.40.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-15.at.1.40.07.AM-1.mov

MacOS: Desktop

Screen.Recording.2024-12-15.at.2.24.52.AM-1.mov

ishpaul777 · 2024-11-17T20:15:15Z

Bug?: New message fetching and redering is quite jerky as compare to staging it often skips many messages load to end

staging

Screen.Recording.2024-11-18.at.1.38.18.AM.mov

This branch

Screen.Recording.2024-11-18.at.1.36.27.AM.mov

janicduplessis · 2024-11-18T20:21:16Z

@ishpaul777 I can reproduce the problem, looking at it now, thanks!

janicduplessis · 2024-11-19T07:49:25Z

That was harder that I thought to fix, I missed part of what the code did. It also handle pagination cases when new items are added, it adds it progressively to make sure no jumping happens.

ishpaul777 · 2024-11-20T18:49:42Z

Bug: Now i can't scroll down after linking to ~~first~~ any of the message and only linked messge is shown, after clear cache and restart

Screen.Recording.2024-11-21.at.12.17.07.AM.mov

ishpaul777 · 2024-11-20T19:17:21Z

src/pages/home/report/ReportActionsList.tsx

@@ -582,7 +578,7 @@ function ReportActionsList({
        ({item: reportAction, index}: ListRenderItemInfo<OnyxTypes.ReportAction>) => (
            <ReportActionsListItemRenderer
                reportAction={reportAction}
-                reportActions={reportActions}
+                reportActions={sortedReportActions}


i dont understand the intention of doing this, Can you please clarify?

ah i got it sortedReportActions and reportActions are same reportActions passed from ReportActionsView.tsx

Yea, kind of unrelated cleanup

janicduplessis · 2024-11-21T03:35:40Z

Oh strange, I was testing this exact case. Will check tomorrow.

janicduplessis · 2024-11-22T04:53:16Z

Seems to only happen if the screen is high enough, that's why I didn't catch it during testing. I can now repro.

rlinoz · 2024-11-26T13:04:39Z

Hey @janicduplessis any news on this one?

janicduplessis · 2024-11-27T04:12:44Z

Hey, I haven't had much availability in the past few weeks, will try to pickup work on it soon!

ishpaul777 · 2024-12-04T20:22:41Z

@janicduplessis Did you get chance to look into this?

janicduplessis · 2024-12-04T20:24:31Z

Sorry about the delay, will be able to look at this tomorrow.

janicduplessis · 2024-12-05T21:50:59Z

@ishpaul777 Are you still able to reproduce the issue? Weirdly I am not able to anymore even with increasing my screen resolution like I did last time.

ishpaul777 · 2024-12-06T12:33:59Z

i'll test again shortly 🙇

ishpaul777 · 2024-12-06T21:12:35Z

I can still reproduce, but on a different message not the first

Screen.Recording.2024-12-07.at.2.39.13.AM.mov

ishpaul777 · 2024-12-13T15:09:26Z

Yes I'll review today

janicduplessis · 2024-12-13T17:10:37Z

Conflicts fixed

ishpaul777

lgtm!

rlinoz · 2024-12-16T14:15:27Z

I think we may have broken the jump to new message button, but I can't repro every time

Hit clear cache and restart
Open the link to one of the messages in the chat with a lot of them
Click on New message

Screen.Recording.2024-12-16.at.11.01.51.mov

rlinoz · 2024-12-19T13:30:01Z

@janicduplessis friendly bump on the above

ishpaul777 · 2024-12-23T19:56:11Z

Any updates @janicduplessis ?

ishpaul777 · 2025-01-03T18:37:15Z

waiting for update from @janicduplessis

janicduplessis · 2025-01-06T17:34:23Z

Sorry about the delay I was OOO for the last weeks, going to pickup work on this.

rlinoz · 2025-01-10T13:29:17Z

Hey @janicduplessis do you have an idea of when you will be able to pick this up again?

janicduplessis · 2025-01-11T22:18:16Z

Worked on this today a little bit, I am able to repro the issue so debugging that now.

I also found another bug while trying to reproduce this, but not related as it happens on main. Will report that in slack.

janicduplessis · 2025-01-13T02:11:17Z

@rlinoz Good catch, fixed now!

rlinoz · 2025-01-13T13:15:20Z

Nice! I think we have a few failling tests though @janicduplessis

rlinoz · 2025-01-15T12:14:23Z

bump on this one @janicduplessis

janicduplessis · 2025-01-15T15:53:29Z

Working on fixing tests today!

janicduplessis · 2025-01-17T02:08:01Z

@rlinoz Tests are now fixed. I ended up extracting the batching logic to make it easier to mock it in the tests so we can keep the rendering sync and simpler.

There are a few lints errors that are popping now, but I didn't change that code, do you know if I need to do something about it?

rlinoz · 2025-01-17T12:58:33Z

Thanks @janicduplessis , I will review again

For the lint errors, I think since this PR touches the files and they all look like simple changes ideally we should fix here

janicduplessis · 2025-01-17T15:25:07Z

Sounds good, will fix it today

janicduplessis · 2025-01-17T17:23:41Z

@rlinoz All checks are passing now, the last commit includes the fix for the lint error.

rlinoz

It is testing well, thanks for all the effort!

OSBotify · 2025-01-17T17:37:10Z

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

janicduplessis · 2025-01-17T18:30:06Z

Thanks @rlinoz, going to move back to #51366 now to use these changes to implement opening at last unread.

janicduplessis mentioned this pull request Nov 6, 2024

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

Open

6 tasks

Move logic to start report actions list at index to BaseInvertedFlatList

da55621

janicduplessis force-pushed the @janic/rav-refactor-v2 branch from db777e7 to da55621 Compare November 7, 2024 01:07

janicduplessis marked this pull request as ready for review November 7, 2024 01:51

janicduplessis requested a review from a team as a code owner November 7, 2024 01:51

melvin-bot bot requested review from ishpaul777 and removed request for a team November 7, 2024 01:52

Fix jumping during pagination

5a71c7b

rlinoz self-requested a review November 19, 2024 15:04

ishpaul777 reviewed Nov 20, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into @janic/rav-refactor-v2

b7afc81

ishpaul777 approved these changes Dec 14, 2024

View reviewed changes

perunt mentioned this pull request Dec 17, 2024

[$250] Android - Chat - Chat is not autoscrolled when sending new message after opened from search. #52878

Open

8 tasks

Merge remote-tracking branch 'upstream/main' into @janic/rav-refactor-v2

877e338

Fix case when current item is removed

2d8c6e9

janicduplessis added 2 commits January 16, 2025 16:03

Abstract batch logic to mock in tests

b438b36

Always render all items if initialKey is null

ce4dfcc

janicduplessis added 2 commits January 17, 2025 12:02

Fix lint

02fc6b0

Merge remote-tracking branch 'upstream/main' into @janic/rav-refactor-v2

f76ad12

rlinoz approved these changes Jan 17, 2025

View reviewed changes

rlinoz merged commit 212a818 into Expensify:main Jan 17, 2025
16 checks passed

Move logic to start report actions list at index to BaseInvertedFlatList #52149

Move logic to start report actions list at index to BaseInvertedFlatList #52149

Conversation

janicduplessis commented Nov 6, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 7, 2024

janicduplessis commented Nov 7, 2024

rlinoz commented Nov 8, 2024 • edited Loading

janicduplessis commented Nov 12, 2024 • edited Loading

ishpaul777 commented Nov 12, 2024

rlinoz commented Nov 14, 2024

ishpaul777 commented Nov 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented Nov 17, 2024

janicduplessis commented Nov 18, 2024

janicduplessis commented Nov 19, 2024

ishpaul777 commented Nov 20, 2024 • edited Loading

ishpaul777 Nov 20, 2024

Choose a reason for hiding this comment

ishpaul777 Nov 20, 2024

Choose a reason for hiding this comment

janicduplessis Nov 21, 2024

Choose a reason for hiding this comment

janicduplessis commented Nov 21, 2024

janicduplessis commented Nov 22, 2024

rlinoz commented Nov 26, 2024

janicduplessis commented Nov 27, 2024

ishpaul777 commented Dec 4, 2024

janicduplessis commented Dec 4, 2024

janicduplessis commented Dec 5, 2024

ishpaul777 commented Dec 6, 2024

ishpaul777 commented Dec 6, 2024

ishpaul777 commented Dec 13, 2024

janicduplessis commented Dec 13, 2024

ishpaul777 left a comment

Choose a reason for hiding this comment

rlinoz commented Dec 16, 2024

rlinoz commented Dec 19, 2024

ishpaul777 commented Dec 23, 2024

ishpaul777 commented Jan 3, 2025

janicduplessis commented Jan 6, 2025

rlinoz commented Jan 10, 2025

janicduplessis commented Jan 11, 2025

janicduplessis commented Jan 13, 2025

rlinoz commented Jan 13, 2025

rlinoz commented Jan 15, 2025

janicduplessis commented Jan 15, 2025

janicduplessis commented Jan 17, 2025

rlinoz commented Jan 17, 2025

janicduplessis commented Jan 17, 2025

janicduplessis commented Jan 17, 2025

rlinoz left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 17, 2025

janicduplessis commented Jan 17, 2025

janicduplessis commented Nov 6, 2024 •

edited

Loading

rlinoz commented Nov 8, 2024 •

edited

Loading

janicduplessis commented Nov 12, 2024 •

edited

Loading

ishpaul777 commented Nov 17, 2024 •

edited

Loading

ishpaul777 commented Nov 20, 2024 •

edited

Loading