Migrate LHNOptionsList to Flashlist #31052

TMisiukiewicz · 2023-11-08T09:30:26Z

Details

Fixed Issues

$ #30910
PROPOSAL:

Tests

Log in into the account (possibly with a lot of chats)
Scroll the LHN list
Verify scrolling goes smoothly

Verify that no errors appear in the JS console

Offline tests

QA Steps

Log in into the account (possibly with a lot of chats)
Scroll the LHN list
Verify scrolling goes smoothly

Verify that no errors appear in the JS console

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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed 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 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 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.js 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

ANDROID.mov

Android: mWeb Chrome

ANDROID_WEB.mov

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS_WEB.mp4

MacOS: Chrome / Safari

WEB.mov

MacOS: Desktop

DESKTOP.mov

rezkiy37

Left comments.

rezkiy37 · 2023-11-08T10:07:47Z

src/components/LHNOptionsList/LHNOptionsList.js

@@ -19,11 +20,10 @@ import OptionRowLHNData from './OptionRowLHNData';
 const propTypes = {
    /** Wrapper style for the section list */
    // eslint-disable-next-line react/forbid-prop-types
-    style: PropTypes.arrayOf(PropTypes.object),
+    style: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]),


Suggested change

style: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]),

style: stylePropTypes,

rezkiy37 · 2023-11-08T10:07:56Z

src/components/LHNOptionsList/LHNOptionsList.js


    /** Extra styles for the section list container */
-    // eslint-disable-next-line react/forbid-prop-types
-    contentContainerStyles: PropTypes.arrayOf(PropTypes.object).isRequired,
+    contentContainerStyles: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]).isRequired,


Suggested change

contentContainerStyles: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]).isRequired,

contentContainerStyles: stylePropTypes,

rezkiy37 · 2023-11-08T10:14:23Z

src/components/LHNOptionsList/LHNOptionsList.js


    /** Extra styles for the section list container */
-    // eslint-disable-next-line react/forbid-prop-types
-    contentContainerStyles: PropTypes.arrayOf(PropTypes.object).isRequired,
+    contentContainerStyles: stylePropTypes,


Suggested change

contentContainerStyles: stylePropTypes,

contentContainerStyles: stylePropTypes.isRequired,

rezkiy37

Sorry, one minor comment.

TMisiukiewicz · 2023-11-08T13:32:58Z

Investigating failed tests, once they are fixed it's ready for review. I will be off Thusday and Friday, In case I couldn't fix it today, could you plase take a look on it @adhorodyski ? 🙏

adhorodyski · 2023-11-08T15:38:55Z

on it!

TMisiukiewicz · 2023-11-13T16:50:54Z

Reduced the amount of failing tests from ~30 to 11 - all in SidebarOrderTest. From my investigation, it seems to happen only in the tests, and while testing on web it works fine. Not sure about what's exactly going on there - when testing displaying LHNOptionList in the correct order, the data prop gets items in the correct order, but renderItem is still called with the previous order. I noticed that if i changed the keyExtractor for index for testing purposes, all the tests went green. Has anyone experienced something like this while working with FlashList? Or maybe there is something I should modify in the tests itself to make it work?

adhorodyski · 2023-11-14T16:32:03Z

@mountiny unfortunately we can't yet undraft this PR - there are still Reassure tests to be fixed (and they fail locally). Hopefully this can be resolved tomorrow. Unit tests are now passing 🙂

melvin-bot · 2023-11-15T09:32:28Z

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

mountiny · 2023-11-15T12:09:57Z

@ntdiary could you please start on testing this PR? In the meantime Callstack engineers will look into the failing reassure tests. Thank you!

ntdiary · 2023-11-15T13:11:16Z

@mountiny, my plate is full at the moment, will request another c+. : )

TMisiukiewicz · 2023-11-15T15:59:11Z

Tests are fixed, but we are experiencing increased render count in reassure, for now I'm not sure if it's the way FlashList works - gonna investigate it tomorrow

TMisiukiewicz · 2023-11-16T15:15:29Z

Investigated the increased amount of rerenders - according to the FlashList docs:

FlashList doesn't render items in the first cycle. Items are drawn after it measures itself at the end of first render.

I think that's the main reason behind additional renders indicated by Reassure. With this in mind, would it be possible to merge that PR with Reassure GH Action failing? It should set a new baseline on main and any further changes should be compared to this.

rushatgabhane · 2023-11-17T03:47:42Z

src/styles/styles.ts

@@ -1367,7 +1367,6 @@ const styles = (theme: ThemeColors) =>
        },

        sidebarListContainer: {
-            scrollbarWidth: 'none',


WEB: On staging, we don't have a scroll bar in LHN.
Let's remove the scrollbar.

rushatgabhane · 2023-11-17T05:22:02Z

Rest looks good!

TMisiukiewicz · 2023-11-17T07:49:23Z

@rushatgabhane thank you for your review, I addressed your comments

rushatgabhane

LGTM!

roryabraham · 2023-11-18T16:56:52Z

Merging despite 2 extra re-renders in reassure.

melvin-bot · 2023-11-18T16:57:09Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

roryabraham · 2023-11-18T16:57:34Z

Not an emergency, just establishing a new baseline for renders with a different component

OSBotify · 2023-11-18T17:00:39Z

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

Julesssss · 2023-11-21T11:56:22Z

Generating an AdHoc build for testing as I'm wondering if this PR introduced this regression. ...

OSBotify · 2023-11-21T12:34:41Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/31052/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/31052/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/31052/NewExpensify.dmg	https://31052.pr-testing.expensify.com

Julesssss · 2023-11-21T13:32:23Z

Yeah, OptionsListSkeletonView modifications seems the likely cause of this regression. This ^ iOS build contains the regression

@TMisiukiewicz are you able to look at this today? If not I can easily revert and we can attempt another PR this week.

situchan · 2023-11-21T13:33:51Z

This maybe caused #31581 as well which was demoted to NAB as it's style issue

TMisiukiewicz · 2023-11-21T13:38:54Z

@Julesssss @situchan taking a look on both issues now

Julesssss · 2023-11-21T15:53:43Z

Okay, I'm pretty sure now that this PR introduced the issue as the parent commit of your first change doesn't contain the bug:

RPReplay_Final1701186535.MP4

OSBotify · 2023-11-22T00:49:57Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

JmillsExpensify · 2023-12-28T22:09:29Z

@roryabraham can I get a payment summary on this PR? @rushatgabhane is requesting payment.

roryabraham · 2023-12-29T01:57:16Z

Yep, this is just a standard C+ PR review, but it caused a regression. So $250 to @rushatgabhane and that's all here. All other involved parties will invoice separately

JmillsExpensify · 2024-01-02T15:26:57Z

Thanks! $250 payment approved for @rushatgabhane based on comment above.

adhorodyski approved these changes Nov 8, 2023

View reviewed changes

rezkiy37 suggested changes Nov 8, 2023

View reviewed changes

TMisiukiewicz requested a review from rezkiy37 November 8, 2023 10:13

rezkiy37 reviewed Nov 8, 2023

View reviewed changes

TMisiukiewicz force-pushed the feat/lhn-flashlist-migration branch from d4b2b23 to 2a51e8b Compare November 8, 2023 10:15

rezkiy37 approved these changes Nov 8, 2023

View reviewed changes

TMisiukiewicz force-pushed the feat/lhn-flashlist-migration branch from 2a51e8b to 4d228b2 Compare November 8, 2023 11:03

TMisiukiewicz force-pushed the feat/lhn-flashlist-migration branch 2 times, most recently from d24eb58 to c7257b3 Compare November 13, 2023 12:49

TMisiukiewicz mentioned this pull request Nov 13, 2023

[HOLD for payment 2023-12-04] [CRITICAL] Migrate the LHNOptionsList to Flashlist #30910

Closed

TMisiukiewicz marked this pull request as ready for review November 15, 2023 09:32

TMisiukiewicz requested a review from a team as a code owner November 15, 2023 09:32

melvin-bot bot requested review from ntdiary and removed request for a team November 15, 2023 09:32

mountiny requested review from rushatgabhane and removed request for ntdiary November 15, 2023 13:15

roryabraham self-requested a review November 15, 2023 16:05

TMisiukiewicz force-pushed the feat/lhn-flashlist-migration branch from cafc4c5 to 3c428c2 Compare November 16, 2023 15:19

TMisiukiewicz added 2 commits November 16, 2023 16:20

migrate LHNOptionsList to FlashList

bb56b98

add currentReportID to extraData

d570eb1

rushatgabhane reviewed Nov 17, 2023

View reviewed changes

hide vertical scroll indicator

fb01718

rushatgabhane approved these changes Nov 17, 2023

View reviewed changes

roryabraham approved these changes Nov 18, 2023

View reviewed changes

roryabraham merged commit 4df083c into Expensify:main Nov 18, 2023
15 of 16 checks passed

melvin-bot bot added the Emergency label Nov 18, 2023

roryabraham removed the Emergency label Nov 18, 2023

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

Julesssss added the Ready To Build label Nov 21, 2023

Julesssss assigned TMisiukiewicz Nov 21, 2023

Julesssss mentioned this pull request Nov 21, 2023

[HOLD for payment 2023-12-04] Login - Background color of chat list is different from the header in LHN when it is loading #31581

Closed

6 tasks

Julesssss mentioned this pull request Nov 21, 2023

[HOLD for payment 2023-12-04] [HOLD for payment 2023-11-30] [$500] iOS - LHN - Skeleton appears instead of LHN if user go offline #31610

Closed

6 tasks

situchan mentioned this pull request Nov 21, 2023

[NO QA] Revert "Migrate LHNOptionsList to Flashlist" #31642

Merged

57 tasks

TMisiukiewicz mentioned this pull request Nov 22, 2023

[perf] Migrate LHNOptionList to FlashList #31711

Merged

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate LHNOptionsList to Flashlist #31052

Migrate LHNOptionsList to Flashlist #31052

TMisiukiewicz commented Nov 8, 2023 •

edited by github-actions bot

Loading

rezkiy37 left a comment

rezkiy37 Nov 8, 2023

rezkiy37 Nov 8, 2023

rezkiy37 Nov 8, 2023

rezkiy37 left a comment

TMisiukiewicz commented Nov 8, 2023

adhorodyski commented Nov 8, 2023

TMisiukiewicz commented Nov 13, 2023

adhorodyski commented Nov 14, 2023 •

edited

Loading

melvin-bot bot commented Nov 15, 2023

mountiny commented Nov 15, 2023

ntdiary commented Nov 15, 2023

TMisiukiewicz commented Nov 15, 2023

TMisiukiewicz commented Nov 16, 2023

rushatgabhane Nov 17, 2023 •

edited

Loading

rushatgabhane commented Nov 17, 2023

TMisiukiewicz commented Nov 17, 2023

rushatgabhane left a comment

roryabraham commented Nov 18, 2023

melvin-bot bot commented Nov 18, 2023

roryabraham commented Nov 18, 2023

OSBotify commented Nov 18, 2023

Julesssss commented Nov 21, 2023

OSBotify commented Nov 21, 2023

Julesssss commented Nov 21, 2023

situchan commented Nov 21, 2023

TMisiukiewicz commented Nov 21, 2023

Julesssss commented Nov 21, 2023

OSBotify commented Nov 22, 2023

JmillsExpensify commented Dec 28, 2023

roryabraham commented Dec 29, 2023

JmillsExpensify commented Jan 2, 2024

	style: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]),
	style: stylePropTypes,

	contentContainerStyles: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), PropTypes.object]).isRequired,
	contentContainerStyles: stylePropTypes,

	contentContainerStyles: stylePropTypes,
	contentContainerStyles: stylePropTypes.isRequired,

Migrate LHNOptionsList to Flashlist #31052

Migrate LHNOptionsList to Flashlist #31052

Conversation

TMisiukiewicz commented Nov 8, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

rezkiy37 Nov 8, 2023

Choose a reason for hiding this comment

rezkiy37 Nov 8, 2023

Choose a reason for hiding this comment

rezkiy37 Nov 8, 2023

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

TMisiukiewicz commented Nov 8, 2023

adhorodyski commented Nov 8, 2023

TMisiukiewicz commented Nov 13, 2023

adhorodyski commented Nov 14, 2023 • edited Loading

melvin-bot bot commented Nov 15, 2023

mountiny commented Nov 15, 2023

ntdiary commented Nov 15, 2023

TMisiukiewicz commented Nov 15, 2023

TMisiukiewicz commented Nov 16, 2023

rushatgabhane Nov 17, 2023 • edited Loading

Choose a reason for hiding this comment

rushatgabhane commented Nov 17, 2023

TMisiukiewicz commented Nov 17, 2023

rushatgabhane left a comment

Choose a reason for hiding this comment

roryabraham commented Nov 18, 2023

melvin-bot bot commented Nov 18, 2023

roryabraham commented Nov 18, 2023

OSBotify commented Nov 18, 2023

Julesssss commented Nov 21, 2023

OSBotify commented Nov 21, 2023

Julesssss commented Nov 21, 2023

situchan commented Nov 21, 2023

TMisiukiewicz commented Nov 21, 2023

Julesssss commented Nov 21, 2023

OSBotify commented Nov 22, 2023

JmillsExpensify commented Dec 28, 2023

roryabraham commented Dec 29, 2023

JmillsExpensify commented Jan 2, 2024

TMisiukiewicz commented Nov 8, 2023 •

edited by github-actions bot

Loading

adhorodyski commented Nov 14, 2023 •

edited

Loading

rushatgabhane Nov 17, 2023 •

edited

Loading