SearchPage list refactor #33080

lukemorawski · 2023-12-14T16:16:10Z

Details

This PR refactors <SearchPage /> component to use new .
At the same time the whole component's architecture to a functional one from class based.
A hook useDebouncedState was added to streamline debouncing search string value.

Fixed Issues

$ #20354
PROPOSAL: no proposal - draft PR

Tests

same as QA steps
Verify that no errors appear in the JS console

Offline tests

same as QA steps

QA Steps

run the app and hit the magnifying glass icon button in the top bar (search)
check the search page functionality for any abnormalities in comparison to the current one
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

native.android.mov

Android: mWeb Chrome

web.android.mov

iOS: Native

native.ios.mp4

iOS: mWeb Safari

web.ios.mov

MacOS: Chrome / Safari

web.desktop.mov

MacOS: Desktop

native.desktop.mov

…earchpage_list_refactor

melvin-bot · 2023-12-18T14:13:58Z

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

src/pages/SearchPage.js

src/pages/SearchPage/index.js

adhorodyski · 2023-12-18T15:45:36Z

src/pages/SearchPage/index.js

+        return newSections;
+    }, [localPersonalDetails, recentReports, userToInvite]);
+
+    const selectReport = (option) => {


How is the performance/renders situation without these 2 being memoed in any way? Are you able to compare the two?

@adhorodyski checked it and compared it to previous (class based) version of this component and it's in the same place, which means - renders (depends on edge case). Also measured performance on web, though not on HTA and it looks good. If you have an access to an HT account I would gladly check against it too!

src/pages/SearchPage/index.js

rushatgabhane · 2023-12-28T06:39:26Z

src/pages/SearchPage/SearchPageFooter.tsx

+    const {translate} = useLocalize();
+
+    return (
+        <View style={[themeStyles.pb5, themeStyles.flexShrink0]}>


The footer has a larger padding than what staging has

src/pages/SearchPage/index.js

rushatgabhane · 2024-01-08T12:46:57Z

@lukemorawski is the search component supposed to be shown in left side of the page?

lukemorawski · 2024-01-08T16:48:18Z

@lukemorawski is the search component supposed to be shown in left side of the page?

That's how it's on staging currently. I haven't messed with the layout, just swapped the list component.

rushatgabhane · 2024-01-10T05:14:13Z

@lukemorawski sorry for the delay here! I will try to get it over the finish line today

rushatgabhane · 2024-01-10T06:28:26Z

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Screen.Recording.2024-01-10.at.12.04.19.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-01-10.at.12.08.50.mov

MacOS: Desktop

rushatgabhane

LGTM!

OSBotify · 2024-01-10T12:02:14Z

✋ 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 · 2024-01-11T09:58:46Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.24-4 🚀

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

OSBotify · 2024-01-15T11:40:06Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

mountiny · 2024-01-22T22:19:56Z

src/pages/SearchPage/index.js

@@ -0,0 +1,183 @@
+import PropTypes from 'prop-types';


Noting here as well @rushatgabhane @adhorodyski @lukemorawski This page was added but the original SearchPage.js was not removed from the /pages folder so the app is actually using code from the original file

@mountiny Actually I did remove the original file but probably it slipped in when merging this branch with main.

Will prepare a quick PR removing the old file.

lukemorawski and others added 10 commits December 5, 2023 14:59

refactor to functional component

97fbe84

list refactor

a999180

moved useDebouncedState hook to an independent file

71b5056

removed comment and unused param

186bfb2

removed old SearchPage component

e859ff1

Merge branch 'main' into searchpage_list_refactor

ba39519

Merge branch 'main' into searchpage_list_refactor

d4c611f

fixed theme hooks import

ad06aff

Merge remote-tracking branch 'origin/searchpage_list_refactor' into s…

f3eceb7

…earchpage_list_refactor

Merge branch 'main' into searchpage_list_refactor

d6a29a5

lukemorawski marked this pull request as ready for review December 18, 2023 14:13

lukemorawski requested a review from a team as a code owner December 18, 2023 14:13

melvin-bot bot requested review from rushatgabhane and removed request for a team December 18, 2023 14:13