Remove hacks in web InvertedFlatList #31288

janicduplessis · 2023-11-14T03:24:10Z

Details

Now that RN web is updated it should fix a bug that was happening causing us to have to use batchSize = 1 on web. After doing some more testing I noticed it was still buggy and tracked it down to the custom getItemLayout implementation. I assume this used to be needed to fix bugs in FlatList but it doesn't seem to be needed anymore. FlatList already caches cells it measures so it is not needed. After removing the custom getItemLayout using the default batch size now works fine. This seems to reduce blanks a lot.

Here you can observe with FlatList debug=true the virtualization window (yellow part) and the viewport (red box).

Before:

Screen.Recording.2023-11-13.at.22.41.32.mov

Virtualization seems broken and the list jumps around for a while.

After:

Screen.Recording.2023-11-13.at.22.44.51.mov

Virtualization works fine and no more jumping. Also no more blanks with bigger batch size, you can also observe how the viewport never gets close to the end of the render window compared to before where we keep hitting the top.

I also removed the extra component for forwarding ref, we can just use forwardRef directly BaseInvertedFlatList no need for an extra component.

Fixed Issues

$#30895
PROPOSAL: N/A

Tests

Tested by scrolling in various chats.

Use the FlatList debug prop to make sure virtualization is working properly.

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

N/A

Android: mWeb Chrome

iOS: Native

N/A

iOS: mWeb Safari

MacOS: Chrome / Safari

Chrome

Screen.Recording.2023-11-13.at.22.52.21.mov

Safari

Screen.Recording.2023-11-13.at.22.56.39.mov

MacOS: Desktop

melvin-bot · 2023-11-14T03:55:34Z

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

situchan · 2023-11-14T06:43:55Z

I can review & test if C+ is required here

perunt · 2023-11-14T07:44:12Z

@situchan it would be great! we need to review it as it's a core feature

situchan · 2023-11-14T09:15:50Z

Here's example report with lots of messages:
https://dev.new.expensify.com:8082/r/5593084223054221

Scroll is still not smooth but much better than current version. At least fixes the super weird bug.

Before: (not able to reach the very first message and keep scrolling forever even if I am not scrolling)

Screen.Recording.2023-11-14.at.3.07.51.PM.mov

After:

Screen.Recording.2023-11-14.at.3.03.34.PM.mov

situchan · 2023-11-14T09:37:41Z

On native, very hard to scroll up to see older messages. Is this out of scope for this PR?

EDIT: Given that this PR doesn't affect native, should be out of scope

ios.mov

situchan · 2023-11-14T10:25:59Z

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

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2023-11-14T10:27:58Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31301.

situchan · 2023-11-14T10:29:17Z

@nkuoch all yours

janicduplessis · 2023-11-14T13:56:34Z

@situchan Thanks for the review! Yes it only affects web so that would be out of scope.

janicduplessis · 2023-11-14T13:59:00Z

Is the perf problem in dev mode? I usually have to disable prop types checking to get decent perf in dev. (I force the production code path in prop-types package index.js)

situchan · 2023-11-14T14:06:33Z

Is the perf problem in dev mode? I usually have to disable prop types checking to get decent perf in dev. (I force the production code path in prop-types package index.js)

Maybe better in production. But can you still try in dev with the report I shared above?

janicduplessis · 2023-11-14T14:57:51Z

@situchan Yea, this report is not as smooth as the simple text messages one I used. I can try profiling it for potential other improvements.

OSBotify · 2023-11-14T20:00:41Z

✋ 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-11-14T22:08:40Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:51:55Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:07:18Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.0-0 🚀

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

janicduplessis added 2 commits November 13, 2023 22:25

Use default batch size on web

d917217

Remove measure items and cleanup BaseInvertedFlatList

68946cc

janicduplessis force-pushed the @janic/web-batch-size branch from a712c5a to 68946cc Compare November 14, 2023 03:27

janicduplessis marked this pull request as ready for review November 14, 2023 03:55

janicduplessis requested a review from a team as a code owner November 14, 2023 03:55

melvin-bot bot requested review from nkuoch and removed request for a team November 14, 2023 03:55

This was referenced Nov 14, 2023

[$500] When scrolling backwards the messages with longer chats stuck and need to scroll forward #30895

Closed

Implement Comment Linking! #23229

Closed

situchan approved these changes Nov 14, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Nov 14, 2023

[Due 11/21]Payment issue for E/App PR#31288 #31301

Closed

nkuoch approved these changes Nov 14, 2023

View reviewed changes

nkuoch merged commit 38344bd into Expensify:main Nov 14, 2023
19 of 25 checks passed

janicduplessis deleted the @janic/web-batch-size branch November 14, 2023 20:56

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

kosmydel mentioned this pull request Nov 20, 2023

[HOLD on #16660][$1000] Web – Assign Task – Whole page jitter on check and uncheck of checkbox. #22656

Closed

6 tasks

mallenexpensify 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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove hacks in web InvertedFlatList #31288

Remove hacks in web InvertedFlatList #31288

janicduplessis commented Nov 14, 2023 •

edited

Loading

melvin-bot bot commented Nov 14, 2023

situchan commented Nov 14, 2023

perunt commented Nov 14, 2023

situchan commented Nov 14, 2023

situchan commented Nov 14, 2023 •

edited

Loading

situchan commented Nov 14, 2023

melvin-bot bot commented Nov 14, 2023

situchan commented Nov 14, 2023

janicduplessis commented Nov 14, 2023

janicduplessis commented Nov 14, 2023 •

edited

Loading

situchan commented Nov 14, 2023

janicduplessis commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

Remove hacks in web InvertedFlatList #31288

Remove hacks in web InvertedFlatList #31288

Conversation

janicduplessis commented Nov 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 14, 2023

situchan commented Nov 14, 2023

perunt commented Nov 14, 2023

situchan commented Nov 14, 2023

situchan commented Nov 14, 2023 • edited Loading

situchan commented Nov 14, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Nov 14, 2023

situchan commented Nov 14, 2023

janicduplessis commented Nov 14, 2023

janicduplessis commented Nov 14, 2023 • edited Loading

situchan commented Nov 14, 2023

janicduplessis commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

janicduplessis commented Nov 14, 2023 •

edited

Loading

situchan commented Nov 14, 2023 •

edited

Loading

janicduplessis commented Nov 14, 2023 •

edited

Loading