refactor: LHN dataflow rework #30242

adhorodyski · 2023-10-24T11:05:17Z

This PR refactors a dataflow for the LHNOptionsList component to be top-down - all data is being fetched on the top level (list), processed and passed down to the renderItem via props - instead of passing a string of reportID and reading for all the collections' keys from Onyx per item.

This effort is an enabler for the Flashlist migration happening as part of this issue: #28902

Details

Fixed Issues

$ #28902 partially

Tests

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

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

Screenshots/Videos

To be added.

Android: Native

ANDROID.mov

Android: mWeb Chrome

ANDROID_WEB.mov

iOS: Native

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

MacOS: Desktop

desktop.mp4

adhorodyski · 2023-10-30T11:46:30Z

@mountiny just updated the description, feel free to invite any1 interested for the review - I see the pipeline parts failing so definitely will need to update it shortly (eg. tests), but I was able to play around with this branch locally just fine.

Also, please see the Reassure logs yourself - we have -23 on different render count metric, but I will have to fix these tests as the ~45% increase in duration seems like a bug.

mountiny

Thanks @adhorodyski in general this makes sense to me and seems like clean approach too

Curious for review from others before we move onto completing this PR

src/components/LHNOptionsList/LHNOptionsList.js

adhorodyski · 2023-10-30T17:17:51Z

@tgolen I'll definitely make sure to address all of your comments, thanks for taking the time! At the same time I think at this stage it's equally important to run this branch locally as we want to gather feedback on the list's responsiveness and the perceived performance (apart from raw numbers which have improved slightly).
Please let me know if you encounter any issues with this one!

src/components/LHNOptionsList/OptionRowLHNData.js

luacmartins

Approach makes sense to me. Thanks for working on this!

src/components/LHNOptionsList/LHNOptionsList.js

src/components/LHNOptionsList/OptionRowLHNData.js

src/components/LHNOptionsList/LHNOptionsList.js

TMisiukiewicz · 2023-11-03T09:45:31Z

@roryabraham thanks, all comments are addressed now 👍 also removed the OptionRowLHNDataWithFocus, @kacper-mikolajczak I would appreciate additional pair of eyes to make sure everything is fine here :)

src/components/LHNOptionsList/LHNOptionsList.js

roryabraham

LGTM, thanks for all the work here.

melvin-bot · 2023-11-06T08:31:40Z

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

TMisiukiewicz · 2023-11-06T14:03:57Z

unit tests should be green now. @adhorodyski we're still missing iOS native and macOS Chrome videos, could you add them?

This reverts commit f525c48e68416f30c6dc62cd5076ca9cb4544d61.

narefyev91 · 2023-11-06T15:09:11Z

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 / Chrome
- iOS / native
- iOS / 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 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

Web

web.mov

Mobile Web - Chrome

android-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

narefyev91

LGTM!
🎀 👀 🎀 C+ reviewed

tgolen

This PR looks very good!

OSBotify · 2023-11-06T15:51:25Z

✋ 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-06T22:30:55Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.96-0 🚀

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

OSBotify · 2023-11-09T22:48:28Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T15:45:06Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

situchan · 2023-11-20T12:31:01Z

src/components/LHNOptionsList/LHNOptionsList.js

+        ({item: reportID}) => {
+            const itemFullReport = reports[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`] || {};
+            const itemReportActions = reportActions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`];
+            const itemParentReportActions = reportActions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${itemFullReport.parentReportID}`];


As we know already, there was crash after this refactor. itemParentReportActions was expected to be object but there's case of null.

c3024 · 2024-02-26T17:12:08Z

src/components/LHNOptionsList/LHNOptionsList.js

+                '',
+            )}`;
+            const itemComment = draftComments[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${reportID}`] || '';
+            const participantPersonalDetailList = _.values(OptionsListUtils.getPersonalDetailsForAccountIDs(itemFullReport.participantAccountIDs, personalDetails));


This misses an edge case where a user sent a last message in a room and then they leave the room. Then the report participant accountIDs do not include this user accountID and the user's email instead of their username is displayed in LHN. Issue #35477

s77rt · 2024-08-04T22:58:07Z

src/components/LHNOptionsList/LHNOptionsList.js

+                    viewMode={optionMode}
+                    isFocused={!shouldDisableFocusOptions && reportID === currentReportID}
+                    onSelectRow={onSelectRow}
+                    preferredLocale={preferredLocale}


After adding preferredLocale to renderItem we should have added it to the FlatList's extraData too otherwise the list won't re-render

Probably a false positive, the above is true for FlashList only. For FlatList the change in renderItem itself seems enough

adhorodyski force-pushed the lhn-dataflow-rework branch from 9ff38ba to d249d24 Compare October 30, 2023 10:01

mountiny self-requested a review October 30, 2023 10:32

mountiny reviewed Oct 30, 2023

View reviewed changes

mountiny requested review from luacmartins, roryabraham and tgolen October 30, 2023 12:35

tgolen requested changes Oct 30, 2023

View reviewed changes

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

roryabraham reviewed Oct 30, 2023

View reviewed changes

src/components/LHNOptionsList/OptionRowLHNData.js Outdated Show resolved Hide resolved

luacmartins reviewed Oct 30, 2023

View reviewed changes

sebryu mentioned this pull request Oct 31, 2023

Optimized listening to hasDraft property changes #30031

Merged

58 tasks

TMisiukiewicz force-pushed the lhn-dataflow-rework branch from d249d24 to 2bab716 Compare October 31, 2023 12:44

adhorodyski commented Oct 31, 2023

View reviewed changes

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

roryabraham requested changes Nov 2, 2023

View reviewed changes

src/components/LHNOptionsList/OptionRowLHNData.js Outdated Show resolved Hide resolved

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

TMisiukiewicz force-pushed the lhn-dataflow-rework branch 2 times, most recently from de4209d to efda8d0 Compare November 3, 2023 09:41

adhorodyski commented Nov 3, 2023

View reviewed changes

src/components/LHNOptionsList/LHNOptionsList.js Outdated Show resolved Hide resolved

TMisiukiewicz force-pushed the lhn-dataflow-rework branch from 96a571f to f525c48 Compare November 3, 2023 10:29

roryabraham previously approved these changes Nov 4, 2023

View reviewed changes

TMisiukiewicz dismissed roryabraham’s stale review via d64a812 November 6, 2023 08:20

TMisiukiewicz force-pushed the lhn-dataflow-rework branch from edfa13d to d64a812 Compare November 6, 2023 08:20

adhorodyski marked this pull request as ready for review November 6, 2023 08:31

adhorodyski requested a review from a team as a code owner November 6, 2023 08:31

melvin-bot bot requested review from narefyev91 and removed request for a team November 6, 2023 08:31

TMisiukiewicz force-pushed the lhn-dataflow-rework branch from d64a812 to 80fee18 Compare November 6, 2023 14:00

TMisiukiewicz added 4 commits November 6, 2023 15:42

remove OptionRowLHNDataWithFocus

5210444

use usePersonalDetails

c491848

Revert "use usePersonalDetails"

82cde21

This reverts commit f525c48e68416f30c6dc62cd5076ca9cb4544d61.

fix tests

9f7b886

TMisiukiewicz force-pushed the lhn-dataflow-rework branch from 80fee18 to 9f7b886 Compare November 6, 2023 14:42

TMisiukiewicz mentioned this pull request Nov 6, 2023

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

Closed

narefyev91 approved these changes Nov 6, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham November 6, 2023 15:18

roryabraham approved these changes Nov 6, 2023

View reviewed changes

roryabraham requested a review from tgolen November 6, 2023 15:42

tgolen approved these changes Nov 6, 2023

View reviewed changes

tgolen merged commit d75acaf into Expensify:main Nov 6, 2023

TMisiukiewicz approved these changes Nov 6, 2023

View reviewed changes

adhorodyski deleted the lhn-dataflow-rework branch November 6, 2023 20:32

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

TMisiukiewicz mentioned this pull request Nov 7, 2023

Chat - Default avatars are shown in LHN instead of custom ones #30932

Closed

6 tasks

GItGudRatio mentioned this pull request Nov 7, 2023

[HOLD for payment 2023-11-17] [$500] Chat – Page crashes when open attachment preview in any chat and reload the page (Ctrl+R) #30998

Closed

6 tasks

TMisiukiewicz mentioned this pull request Nov 7, 2023

[CP Staging] fix: correctly pass transactions and reportActions to LHN #31007

Merged

59 tasks

kacper-mikolajczak mentioned this pull request Nov 7, 2023

We are merging too many personal details during OpenReport #29262

Closed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

situchan reviewed Nov 20, 2023

View reviewed changes

dukenv0307 mentioned this pull request Nov 23, 2023

[HOLD for payment 2023-12-12] [$500] Incorrect avatar being shown for report in LHN #31284

Closed

6 tasks

c3024 reviewed Feb 26, 2024

View reviewed changes

c3024 mentioned this pull request Feb 26, 2024

[$500] Room - Room preview in LHN shows email instead of display name when user leaves the room #35477

Closed

6 tasks

s77rt reviewed Aug 4, 2024

View reviewed changes

refactor: LHN dataflow rework #30242

refactor: LHN dataflow rework #30242

Uh oh!

Conversation

adhorodyski commented Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

adhorodyski commented Oct 30, 2023

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adhorodyski commented Oct 30, 2023

Uh oh!

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TMisiukiewicz commented Nov 3, 2023

Uh oh!

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Nov 6, 2023

Uh oh!

TMisiukiewicz commented Nov 6, 2023

Uh oh!

narefyev91 commented Nov 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

narefyev91 left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

situchan Nov 20, 2023

Choose a reason for hiding this comment

Uh oh!

c3024 Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt Aug 4, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

adhorodyski commented Oct 24, 2023 •

edited

Loading

narefyev91 commented Nov 6, 2023 •

edited

Loading