BaseShareLogList list refactor #38942

lukemorawski · 2024-03-25T15:55:04Z

Details

This PR replaces deprecated <OptionsSelector /> component in favour of <SelectionList /> and also refactors internal logic, streamlining how searchOptions are created, reducing the render count.

Fixed Issues

$ #20354
PROPOSAL: no proposal

Tests

Same as QA
Verify that no errors appear in the JS console

Offline tests

same as QA

QA Steps

Open Preferences page
Tap About > Troubleshooting
Enable client side logging if it's off
Tap View Debug Console > Share Log
Verify everything works
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 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 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 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.

Screenshots/Videos

Android: Native

native.android.mov

Android: mWeb Chrome

web.android.mov

iOS: Native

native.ios.mov

iOS: mWeb Safari

web.ios.mov

MacOS: Chrome / Safari

web.desktop.mov

MacOS: Desktop

native.desktop.mov

melvin-bot · 2024-03-25T15:55:34Z

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

tgolen

Can you please update the PR description to link to a GH for this work? I would like to have more context behind the work being done.

tgolen · 2024-03-25T19:12:02Z

src/pages/settings/AboutPage/ShareLogList/BaseShareLogList.tsx

+    const betas = useBetas();
+
+    const searchOptions = useMemo(() => {
+        const isOptionsDataReady = ReportUtils.isReportDataReady() && OptionsListUtils.isPersonalDetailsReady(personalDetails);


Should this be outside of the function and then used as a dependency for useMemo()? It seems wrong to be calling it inside this memo since it relies on outside data.

Also, why is useMemo() being done here instead of useEffect()?

That would great but OptionsListUtils.isPersonalDetailsReady(personalDetails); is consuming data coming from the usePersonalDetailsHook so it can't be moved outside the component.

I just tossed it in the useMemo responsible for searchOptions as it's also dependant on personalDetails. Using useEffect with setState is an anti-pattern that should punished by death in most cases.

so it can't be moved outside the component.

Sorry, this isn't really what I was suggesting. I was thinking of just moving it outside of useMemo() but still keeping it inside the component. I'd still like to see if this is possible.

Using useEffect with setState is an anti-pattern that should punished by death in most cases.

Sounds good! I'll avoid the death penalty in that case then.

tgolen · 2024-03-25T19:15:08Z

src/pages/settings/AboutPage/ShareLogList/BaseShareLogList.tsx


-    const updateOptions = useCallback(() => {
+        if (!isMounted.current || !isOptionsDataReady) {
+            isMounted.current = true;


isMounted ref is strange to me as well. Is it really necessary? How could the options data be ready but the component not be mounted?

It seems like it would be better to:

use a ref for searchOptions and have it's default value be what is in this early return

Update the searchOptions ref inside this useMemo()

Alternative thought: Maybe each of these 4 properties should be their own distinct variable. Would that clean up the code at all?

yeah, I kinda bluntly repurposed isMounted flag from the previous version of the component, but I agree, with isOptionsDataReady it's totally unnecessary.

lukemorawski · 2024-03-26T10:14:06Z

Can you please update the PR description to link to a GH for this work? I would like to have more context behind the work being done.

Fixed. Forgot to paste it in.

tgolen · 2024-03-26T14:57:28Z

src/pages/settings/AboutPage/ShareLogList/BaseShareLogList.tsx

+    const betas = useBetas();
+
+    const searchOptions = useMemo(() => {
+        const isOptionsDataReady = ReportUtils.isReportDataReady() && OptionsListUtils.isPersonalDetailsReady(personalDetails);


so it can't be moved outside the component.

Sorry, this isn't really what I was suggesting. I was thinking of just moving it outside of useMemo() but still keeping it inside the component. I'd still like to see if this is possible.

Using useEffect with setState is an anti-pattern that should punished by death in most cases.

Sounds good! I'll avoid the death penalty in that case then.

lukemorawski · 2024-03-26T15:56:50Z

Sorry, this isn't really what I was suggesting. I was thinking of just moving it outside of useMemo() but still keeping it inside the component. I'd still like to see if this is possible.
But why? Now it's nice and snug inside a useMemo, without any perf penalty and perhaps even with some small perf gain, as both of those helper functions are called only when useMemo deps change and not on every render.

tgolen · 2024-03-26T16:03:13Z

I think it just doesn't seem to fit because it's like doing a double-memo almost. If the memo runs and the options data aren't ready, then a default set of options is used. When the memo runs again, and the options data are ready, then the real options are used. It should just not call the memo at all until the options data are ready.

It feels like it should just be more simple than that.

Use default options in the first place which require no helper methods or memo
Once the data is ready (by using memo), then update the search options

lukemorawski · 2024-03-26T16:41:53Z

@tgolen Good thinking and I see your point, but I have few additions:

It should just not call the memo at all until the options data are ready.
The useMemo still will be called, regardless of the position of isOptionDataReady. Let's go through a scenario:
Render cycles:

personalDetails and reports data are not ready - isOptionsDataReady is false. searchOptions useMemo is called and empty values are early returned.
upon next render isOptionsDataReady is true because either reports or personalDetails changed so the useMemo is called again

As you can see it doesn't really matter that much whether the flag's value is calculated inside the useMemo callback function or outside. useMemo hook would still be called as it's dependant on the same data that the flag is. That's why it's logical to group calculations dependent on the same data set. In this case we won't get a perf boost as calculations of the flag are not very "expensive", but still it's something. The number of render cycles doesn't change on the position of the flag either. It's 2 in both cases. Before this refactoring it was 3 renders, so a 33% reduction ;)

tgolen · 2024-03-26T17:50:52Z

OK, I understand there is technically no difference. I can chalk this up to personal preference in that case and not let it be a blocker. Thanks for listening!

lukemorawski · 2024-03-27T09:57:13Z

@tgolen well, in that case I'm happy to make an exception :D

tgolen

Hahaha, OK. Thanks! It looks like we should have a C+ review and test this as well?

tgolen · 2024-03-27T13:40:34Z

@abdulrahuman5196 I think you were intended to be the C+ for this (from looking at the issue), so I've added you as a reviewer. Can you please complete the reviewer checklist on this?

abdulrahuman5196 · 2024-03-27T16:26:14Z

@lukemorawski This PR references #36038 issue which already has a PR - #38039.

Is both PR related? Any background information on this PR?

lukemorawski · 2024-03-28T09:46:34Z

@abdulrahuman5196 sorry, wrong issue number. Fixing that now

abdulrahuman5196 · 2024-03-28T09:53:08Z

@rushatgabhane I think this review is for you. Feel free to takeover. If not I can review as well.

tgolen · 2024-03-29T15:04:55Z

@abdulrahuman5196 For the sake of urgency, let's just move forward with you doing the C+ review for this if you don't mind.

rushatgabhane · 2024-03-30T06:33:53Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-03-30.at.12.46.02.mov

MacOS: Desktop

rushatgabhane

@lukemorawski
Bug: "No results found" is shown even if results are there.

Go to share log page
search for a user

tgolen · 2024-04-02T13:38:49Z

@lukemorawski Can you take a look at that bug, please?

lukemorawski · 2024-04-02T13:40:57Z

yep, I'm resolving some merge conflicts on another PR. Will take a look at that after that.

lukemorawski · 2024-04-04T14:56:08Z

@tgolen @rushatgabhane fixed

OSBotify · 2024-04-08T11:08:32Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:05:10Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:22:47Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

refactorings

cd8d6c2

lukemorawski requested a review from a team as a code owner March 25, 2024 15:55

melvin-bot bot requested review from tgolen and removed request for a team March 25, 2024 15:55

tgolen requested changes Mar 25, 2024

View reviewed changes

removed isMounted flag

52a9f5e

tgolen requested changes Mar 26, 2024

View reviewed changes

move isOptionsDataReady outside of useMemo

59dff36

tgolen previously approved these changes Mar 27, 2024

View reviewed changes

tgolen requested a review from abdulrahuman5196 March 27, 2024 13:39

This comment was marked as outdated.

Sign in to view

melvin-bot bot requested a review from cristipaval March 30, 2024 07:19

rushatgabhane suggested changes Mar 30, 2024

View reviewed changes

rushatgabhane mentioned this pull request Mar 30, 2024

LOW: [$500] Selection List Refactor: Simple Selection List #20354

Closed

Merge branch 'main' into BaseShareLogList_refactor

6da787d

merge fixes and results not found fix

6e2e2c9

lukemorawski dismissed tgolen’s stale review via 6e2e2c9 April 4, 2024 14:48

type fixes

5194168

tgolen approved these changes Apr 4, 2024

View reviewed changes

rushatgabhane approved these changes Apr 5, 2024

View reviewed changes

cristipaval approved these changes Apr 5, 2024

View reviewed changes

cristipaval merged commit e68084d into Expensify:main Apr 5, 2024
18 checks passed

github-actions bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BaseShareLogList list refactor #38942

BaseShareLogList list refactor #38942

lukemorawski commented Mar 25, 2024 •

edited

Loading

melvin-bot bot commented Mar 25, 2024

tgolen left a comment

tgolen Mar 25, 2024

tgolen Mar 25, 2024

lukemorawski Mar 26, 2024

tgolen Mar 26, 2024

tgolen Mar 25, 2024 •

edited

Loading

tgolen Mar 25, 2024

lukemorawski Mar 26, 2024

lukemorawski commented Mar 26, 2024 •

edited

Loading

tgolen Mar 26, 2024

lukemorawski commented Mar 26, 2024

tgolen commented Mar 26, 2024

lukemorawski commented Mar 26, 2024

tgolen commented Mar 26, 2024

lukemorawski commented Mar 27, 2024

tgolen left a comment

tgolen commented Mar 27, 2024

abdulrahuman5196 commented Mar 27, 2024 •

edited

Loading

lukemorawski commented Mar 28, 2024

abdulrahuman5196 commented Mar 28, 2024

tgolen commented Mar 29, 2024 •

edited

Loading

rushatgabhane commented Mar 30, 2024 •

edited

Loading

This comment was marked as outdated.

rushatgabhane left a comment •

edited

Loading

tgolen commented Apr 2, 2024

lukemorawski commented Apr 2, 2024

lukemorawski commented Apr 4, 2024 •

edited

Loading

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

BaseShareLogList list refactor #38942

BaseShareLogList list refactor #38942

Conversation

lukemorawski commented Mar 25, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 25, 2024

tgolen left a comment

Choose a reason for hiding this comment

tgolen Mar 25, 2024

Choose a reason for hiding this comment

tgolen Mar 25, 2024

Choose a reason for hiding this comment

lukemorawski Mar 26, 2024

Choose a reason for hiding this comment

tgolen Mar 26, 2024

Choose a reason for hiding this comment

tgolen Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

tgolen Mar 25, 2024

Choose a reason for hiding this comment

lukemorawski Mar 26, 2024

Choose a reason for hiding this comment

lukemorawski commented Mar 26, 2024 • edited Loading

tgolen Mar 26, 2024

Choose a reason for hiding this comment

lukemorawski commented Mar 26, 2024

tgolen commented Mar 26, 2024

lukemorawski commented Mar 26, 2024

tgolen commented Mar 26, 2024

lukemorawski commented Mar 27, 2024

tgolen left a comment

Choose a reason for hiding this comment

tgolen commented Mar 27, 2024

abdulrahuman5196 commented Mar 27, 2024 • edited Loading

lukemorawski commented Mar 28, 2024

abdulrahuman5196 commented Mar 28, 2024

tgolen commented Mar 29, 2024 • edited Loading

rushatgabhane commented Mar 30, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

This comment was marked as outdated.

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

tgolen commented Apr 2, 2024

lukemorawski commented Apr 2, 2024

lukemorawski commented Apr 4, 2024 • edited Loading

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

lukemorawski commented Mar 25, 2024 •

edited

Loading

tgolen Mar 25, 2024 •

edited

Loading

lukemorawski commented Mar 26, 2024 •

edited

Loading

abdulrahuman5196 commented Mar 27, 2024 •

edited

Loading

tgolen commented Mar 29, 2024 •

edited

Loading

rushatgabhane commented Mar 30, 2024 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

lukemorawski commented Apr 4, 2024 •

edited

Loading