[Search v1] Improve performance of ReportListItem #43092

WojtekBoman · 2024-06-05T08:48:10Z

Details

This PR adds some improvements to ReportListItem:

code is refactored according to the comments added here
components defined within ReportListItem have been moved out of the component.

Fixed Issues

$ #42720
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Replace a value of the data variable with:

 const data = SearchUtils.getSections(
        {
            personalDetailsList: {
                1: {
                    displayName: 'user',
                },
            },
            report_0: {
                reportID: 0,
                reportName: 'Alice’s Apples owes $110.00',
                total: 1000,
                currency: 'USD',
                action: 'pay',
            },
            transactions_1: {
                reportID: 0,
                merchant: 'test',
                amount: 1000,
                created: '2024-01-01',
                accountID: 1,
                managerID: 1,
                category: 'test',
            },
            transactions_2: {
                reportID: 0,
                merchant: 'test 2',
                amount: 2000,
                created: '2024-01-02',
                accountID: 1,
                managerID: 1,
                category: 'test',
            },
        } ?? {},
        type,
    );

in src/components/Search.tsx.
3. Return 'report'; in the getSearchType function in the src/libs/SearchUtils.ts file.
4. Open and log in to the app.
5. Open the Account Settings.
6. Open the Troubleshoot tab.
7. Navigate to the Search Page.
8. Verify that the ReportListItem is displayed correctly.

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Kicu

LGTM, good changes

Kicu · 2024-06-05T09:26:06Z

src/components/SelectionList/Search/ReportListItem.tsx

@@ -45,28 +87,10 @@ function ReportListItem<TItem extends ListItem>({

    const openReportInRHP = (transactionItem: TransactionListItemType) => {
        const searchParams = getSearchParams();
-        const currentQuery = searchParams && `query` in searchParams ? (searchParams?.query as string) : CONST.TAB_SEARCH.ALL;
+        const currentQuery = searchParams?.query ?? CONST.TAB_SEARCH.ALL;


Kicu · 2024-06-05T09:32:00Z

src/libs/SearchUtils.ts

@@ -221,7 +221,7 @@ function getSortedTransactionData(data: TransactionListItemType[], sortBy?: Sear

 function getSearchParams() {
    const topmostCentralPaneRoute = getTopmostCentralPaneRoute(navigationRef.getRootState() as State<RootStackParamList>);
-    return topmostCentralPaneRoute?.params;
+    return topmostCentralPaneRoute?.params as Record<string, string | undefined>;


Suggested change

return topmostCentralPaneRoute?.params as Record<string, string | undefined>;

return topmostCentralPaneRoute?.params as CentralPaneNavigatorParamList['Search_Central_Pane'];

I believe you could cast it like this, and the we would be strictly correct as to what is actually the type.
What do you think? I tested locally and it seems to work

melvin-bot · 2024-06-05T15:41:09Z

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

luacmartins · 2024-06-05T19:00: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 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

MacOS: Desktop

OSBotify · 2024-06-05T19:13:16Z

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

DylanDylann · 2024-06-10T07:22:37Z

@luacmartins Do I need to complete the checklist for this PR?

luacmartins · 2024-06-10T15:04:02Z

No, it's fine. It's a new feature and we'll handle tests as part of the project wrap up

OSBotify · 2024-06-11T23:35:19Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

WojtekBoman added 3 commits June 3, 2024 16:10

Search cleanup

6283fb3

Merge branch 'main' into search-v1/polish-report-list-item

8b29368

Refactor cell components in ReportListItem

24836f7

Kicu approved these changes Jun 5, 2024

View reviewed changes

Refactor getSearchParams

b014f3a

WojtekBoman marked this pull request as ready for review June 5, 2024 15:41

WojtekBoman requested a review from a team as a code owner June 5, 2024 15:41

melvin-bot bot requested review from DylanDylann and removed request for a team June 5, 2024 15:41

luacmartins approved these changes Jun 5, 2024

View reviewed changes

luacmartins merged commit fcfef92 into Expensify:main Jun 5, 2024
15 of 16 checks passed

github-actions bot mentioned this pull request Jun 6, 2024

Deploy Checklist: New Expensify 2024-06-06 #43168

Closed

melvin-bot bot mentioned this pull request Jun 11, 2024

[HOLD for payment 2024-06-20] [Search v1] Improve performance of ReportListItem #42720

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Improve performance of ReportListItem #43092

[Search v1] Improve performance of ReportListItem #43092

WojtekBoman commented Jun 5, 2024 •

edited

Loading

Kicu left a comment

Kicu Jun 5, 2024

Kicu Jun 5, 2024

melvin-bot bot commented Jun 5, 2024

luacmartins commented Jun 5, 2024 •

edited

Loading

OSBotify commented Jun 5, 2024

DylanDylann commented Jun 10, 2024

luacmartins commented Jun 10, 2024

OSBotify commented Jun 11, 2024

	return topmostCentralPaneRoute?.params as Record<string, string \| undefined>;
	return topmostCentralPaneRoute?.params as CentralPaneNavigatorParamList['Search_Central_Pane'];

[Search v1] Improve performance of ReportListItem #43092

[Search v1] Improve performance of ReportListItem #43092

Conversation

WojtekBoman commented Jun 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu Jun 5, 2024

Choose a reason for hiding this comment

Kicu Jun 5, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Jun 5, 2024

luacmartins commented Jun 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 5, 2024

DylanDylann commented Jun 10, 2024

luacmartins commented Jun 10, 2024

OSBotify commented Jun 11, 2024

WojtekBoman commented Jun 5, 2024 •

edited

Loading

luacmartins commented Jun 5, 2024 •

edited

Loading