Convert SearchPage to functional component #23076

Piotrfj · 2023-07-18T12:28:32Z

Details

Fixed Issues

$ #16251
PROPOSAL: proposal not yet created

Tests

Click on search icon in chat list to enter search page.
Verify if the results are the same as on production version of the application.

Verify that no errors appear in the JS console

Offline tests

Click on search icon in chat list to enter search page.
Verify if the results are the same as on production version of the application.

QA Steps

Click on search icon in chat list to enter search page.
Verify if the results are the same as on production version of the application.

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

Web

Kapture.2023-08-23.at.14.57.44.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Kapture.2023-08-23.at.14.57.44.mp4

iOS

Kapture.2023-08-24.at.13.12.01.mp4

Android

Kapture.2023-08-23.at.15.14.34.mp4

github-actions · 2023-07-18T12:28:48Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

Piotrfj · 2023-07-18T12:30:12Z

I have read the CLA Document and I hereby sign the CLA

src/pages/SearchPage.js

gedu · 2023-07-19T08:23:10Z

src/pages/SearchPage.js

-            userToInvite,
-        };
-    }
+    const debouncedUpdateOptions =_.debounce(updateOptions, 75);


_.debounce returns always a new function, probably would be good to wrap it into an useCallback for the useEffect, so you can add it into the dependency array safely

Yes, the app should have the same reference across the re-renders. useCallback is necessary here.

gedu · 2023-07-19T08:25:45Z

src/pages/SearchPage.js

-        this.setState({searchValue}, this.debouncedUpdateOptions);
-    }
+    useEffect(() => {
+        updateOptions();


if updateOptions isn't part of the dependency array, please add a comment explaining why

@gedu, wdyt about the next option - https://github.com/Expensify/App/pull/23076/files#r1267798688?

I just realized that updateOptions useCallback, also is recreated when the searchValue change, I think could be some useEffects and function duplications, would be good to update the logic, and merge where is possible

gedu · 2023-07-19T08:26:44Z

src/pages/SearchPage.js

-            personalDetails,
-        });
+    useEffect(() => {
+        debouncedUpdateOptions()


why are you updating the options after every new word? You are listening to reports and personalDetails to update the options

gedu · 2023-07-19T08:37:25Z

src/pages/SearchPage.js

 }

 SearchPage.propTypes = propTypes;
 SearchPage.defaultProps = defaultProps;
-
+SearchPage.displayName = 'SearchPage';


use hooks useLocalize and useWindowDimensions

rezkiy37 · 2023-07-19T09:15:22Z

src/pages/SearchPage.js

-    }
+    useEffect(() => {
+        updateOptions();
+    },[props.reports, props.personalDetails])


I think this useEffect should have only this function as a dependency. It is logically. Finally, it uses the same deps.

Suggested change

},[props.reports, props.personalDetails])

},[updateOptions])

rezkiy37 · 2023-07-19T09:21:07Z

src/pages/SearchPage.js

-            recentReports,
-            personalDetails,
-        });
+    useEffect(() => {


Could you please group all useEffects in one place instead of having them in random places across the component.

src/pages/SearchPage.js

fabioh8010 · 2023-07-24T12:32:09Z

src/pages/SearchPage.js

-class SearchPage extends Component {
-    constructor(props) {
-        super(props);
+function SearchPage(props) {


Let's use prop destructuring now in order to be aligned with the style guidelines -> https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#destructuring

~~Also, you have to remove usage of defaultProps and assign default values during the prop destructuring.~~

You don't need to do this one now, we should still use defaultProps in JS files.

fabioh8010

Just one nitpick, LGTM!

fabioh8010 · 2023-07-25T09:25:16Z

src/pages/SearchPage.js

-    reports: {},
-};
+function SearchPage({betas = [], personalDetails = {}, reports= {}}) {
+    //Data for initialization (runs only on the first render)


Suggested change

//Data for initialization (runs only on the first render)

// Data for initialization (runs only on the first render)

thiagobrez · 2023-07-25T11:04:12Z

src/pages/SearchPage.js

-    personalDetails: {},
-    reports: {},
-};
+function SearchPage({betas = [], personalDetails = {}, reports= {}}) {


Suggested change

function SearchPage({betas = [], personalDetails = {}, reports= {}}) {

function SearchPage({betas = [], personalDetails = {}, reports = {}}) {

Super nitpick sorry XD

thiagobrez · 2023-07-25T11:28:22Z

@Piotrfj The whole searching flow looks more complex than it needs to be, in my opinion. I know it was already like this before, but I propose the following to make it simpler and prevent a few re-renders:

Merge activeRecentReports, activePersonalDetails and activeUserToInvite into one state object: searchOptions, so you don't have to set 3 states (and therefore 3 re-renders), but only 1
Currently, the onChangeText function is only setting state for searchValue. Then, when searchValue is changed, in the useEffect you're calling debouncedUpdateOptions which calls updateOptions. My suggestion here is to move the updateOptions logic inside onChangeText, so you can delete updateOptions, debouncedUpdateOptions and consequently the useEffect

This is how it would look like in the end:

function SearchPage({betas = [], personalDetails = {}, reports= {}}) {

...

    const [searchValue, setSearchValue] = useState('')
    
    // Only 1 state for the 3 objects here
    const [searchOptions, setSearchOptions] = useState({
      activeRecentReports: initialRecentReports,
      activePersonalDetails: initialPersonalDetails,
      activeUserToInvite: initialUserToInvite
    });

    const {translate} = useLocalize();

    // delete updateOptions

    // delete debouncedUpdateOptions
  
    ...
    
    // delete the debouncedUpdateOptions useEffect

    ...
    
    const onChangeText = (value = '') => {
        setSearchValue(value);
        
        // `updateOptions` logic is here, with the debounce
        _.debounce(() => {
            const {recentReports: localRecentReports, personalDetails: localPersonalDetails, userToInvite: localUserToInvite} = OptionsListUtils.getSearchOptions(
                reports,
                personalDetails,
                searchValue.trim(),
                betas,
            );

            // only 1 state change here prevents rerenders
            setSearchOptions({
                activeUserToInvite: localUserToInvite,
                activeRecentReports: localRecentReports,
                activePersonalDetails: localPersonalDetails,
            });
        }, 75);
    }

}

This way when you look at onChangeText, you know exactly what's gonna happen all in one place, and also prevents re-renders from setting multiple states, and calling unnecessary effects

rezkiy37 · 2023-07-26T11:08:11Z

src/pages/SearchPage.js

-    }
+    useEffect(() => {
+        debouncedUpdateOptions()
+    }, [searchValue, debouncedUpdateOptions])


Actually, searchValue not necessary here.
useEffect has debouncedUpdateOptions has updateOptions has searchValue. BTW, if you want to simplify this chain, you can pass searchValue as an argument to updateOptions.

Suggested change

}, [searchValue, debouncedUpdateOptions])

}, [debouncedUpdateOptions])

rezkiy37 · 2023-07-26T11:10:02Z

src/pages/SearchPage.js

-};
+function SearchPage({betas = [], personalDetails = {}, reports = {}}) {
+    // Data for initialization (runs only on the first render)
+    const {recentReports: initialRecentReports, personalDetails: initialPersonalDetails, userToInvite: initialUserToInvite} = useMemo(() => OptionsListUtils.getSearchOptions(reports, personalDetails, '', betas), []);


Linter will complain on this, so just disable this rule

Suggested change

const {recentReports: initialRecentReports, personalDetails: initialPersonalDetails, userToInvite: initialUserToInvite} = useMemo(() => OptionsListUtils.getSearchOptions(reports, personalDetails, '', betas), []);

// eslint-disable-next-line react-hooks/exhaustive-deps

const {recentReports: initialRecentReports, personalDetails: initialPersonalDetails, userToInvite: initialUserToInvite} = useMemo(() => OptionsListUtils.getSearchOptions(reports, personalDetails, '', betas), []);

melvin-bot · 2023-07-27T08:47:13Z

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

marcaaron · 2023-07-28T18:44:19Z

@thesahindia let's get this tested and reviewed 🙏 🙇

allroundexperts · 2023-08-16T09:46:18Z

@allroundexperts lint issues are fixed, PR is ready

@Piotrfj Can you also please resolve the outstanding comments on your PR?

Piotrfj · 2023-08-21T09:25:48Z

@marcaaron @allroundexperts please accept a pr

allroundexperts · 2023-08-21T09:30:56Z

@Piotrfj I'm on it today!

allroundexperts · 2023-08-21T10:17:55Z

@Piotrfj I still see some un-resolved comments.

Can you please resolve these?

fabioh8010 · 2023-08-21T14:10:59Z

@allroundexperts @Piotrfj You can ignore this comment, is not valid:

Also, you have to remove usage of defaultProps and assign default values during the prop destructuring.

But @Piotrfj let's do this one:

Let's use prop destructuring now in order to be aligned with the style guidelines -> https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#destructuring

allroundexperts · 2023-08-21T23:18:04Z

@Piotrfj Can you please upload screen recordings for all the platforms?

Piotrfj · 2023-08-22T08:37:42Z

@allroundexperts sure, gonna provide them today

allroundexperts · 2023-08-29T21:27:13Z

Bump @Piotrfj

Piotrfj · 2023-08-31T16:48:24Z

@allroundexperts examples provided, sorry for the delay, I was actually providing them earlier but forgot to save them...

marcaaron

Nice changes overall. We are on a merge freeze I think for the next couple of days. So, we will wait a bit before merging. If it goes for too long please tag me back in here!

marcaaron · 2023-09-06T00:20:29Z

The checklist also looks like it went out of date somewhere if we can fix that in the meantime @allroundexperts

marcaaron · 2023-09-14T00:37:43Z

Merge freeze is over so taking this off hold. @allroundexperts can you check my comment above?

allroundexperts · 2023-09-14T00:39:31Z

Merge freeze is over so taking this off hold. @allroundexperts can you check my comment above?

Hi @marcaaron!
I'd be updating it along with testing it again.

allroundexperts

Still testing well!

allroundexperts · 2023-09-14T01:04:22Z

This is ready @marcaaron!

marcaaron

LGTM. Let's 🪨 🤘

OSBotify · 2023-09-14T02:03:13Z

✋ 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-09-14T10:52:10Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:10:09Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

Convert SearchPage to functional component

1a892d2

gedu reviewed Jul 19, 2023

View reviewed changes

src/pages/SearchPage.js Outdated Show resolved Hide resolved

gedu reviewed Jul 19, 2023

View reviewed changes

rezkiy37 reviewed Jul 19, 2023

View reviewed changes

fabioh8010 suggested changes Jul 24, 2023

View reviewed changes

Fix comments in SearchPage refactoring

2d2676e

fabioh8010 approved these changes Jul 25, 2023

View reviewed changes

thiagobrez reviewed Jul 25, 2023

View reviewed changes

marcaaron mentioned this pull request Jul 25, 2023

[HOLD for payment 2023-12-29] [$250] Migrate SearchPage.js to function component #16251

Closed

1 task

marcaaron self-requested a review July 25, 2023 19:38

marcaaron assigned Piotrfj Jul 25, 2023

Piotrfj added 3 commits July 26, 2023 11:50

refactor state in SearchPage

804cc20

fix typo

d49f271

fix debounced updated function

c187f69

rezkiy37 reviewed Jul 26, 2023

View reviewed changes

Piotrfj marked this pull request as ready for review July 27, 2023 08:47

Piotrfj requested a review from a team as a code owner July 27, 2023 08:47

melvin-bot bot removed the request for review from a team July 27, 2023 08:47

melvin-bot bot requested a review from thesahindia July 27, 2023 08:47

thiagobrez mentioned this pull request Jul 28, 2023

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

Closed

fix prettier

6024bce

destructure the props

22042e5

marcaaron changed the title ~~Convert SearchPage to functional component~~ [HOLD merge freeze] Convert SearchPage to functional component Sep 6, 2023

marcaaron approved these changes Sep 6, 2023

View reviewed changes

marcaaron changed the title ~~[HOLD merge freeze] Convert SearchPage to functional component~~ Convert SearchPage to functional component Sep 14, 2023

allroundexperts approved these changes Sep 14, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron September 14, 2023 01:03

marcaaron requested changes Sep 14, 2023

View reviewed changes

marcaaron self-requested a review September 14, 2023 01:57

marcaaron approved these changes Sep 14, 2023

View reviewed changes

marcaaron merged commit e18ec42 into Expensify:main Sep 14, 2023
16 of 17 checks passed

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

This was referenced Sep 14, 2023

[HOLD for payment 2023-09-27] mWeb/safari- Transition is not smooth when search page opened #27457

Closed

Revert "Convert SearchPage to functional component" #27476

Merged

	//Data for initialization (runs only on the first render)
	// Data for initialization (runs only on the first render)

	function SearchPage({betas = [], personalDetails = {}, reports= {}}) {
	function SearchPage({betas = [], personalDetails = {}, reports = {}}) {

	}, [searchValue, debouncedUpdateOptions])
	}, [debouncedUpdateOptions])

	const {recentReports: initialRecentReports, personalDetails: initialPersonalDetails, userToInvite: initialUserToInvite} = useMemo(() => OptionsListUtils.getSearchOptions(reports, personalDetails, '', betas), []);
	// eslint-disable-next-line react-hooks/exhaustive-deps
	const {recentReports: initialRecentReports, personalDetails: initialPersonalDetails, userToInvite: initialUserToInvite} = useMemo(() => OptionsListUtils.getSearchOptions(reports, personalDetails, '', betas), []);

Convert SearchPage to functional component #23076

Convert SearchPage to functional component #23076

Conversation

Piotrfj commented Jul 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jul 18, 2023 • edited Loading

Piotrfj commented Jul 18, 2023

gedu Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gedu Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

rezkiy37 Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabioh8010 Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thiagobrez commented Jul 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 27, 2023

marcaaron commented Jul 28, 2023

allroundexperts commented Aug 16, 2023

Piotrfj commented Aug 21, 2023

allroundexperts commented Aug 21, 2023

allroundexperts commented Aug 21, 2023

fabioh8010 commented Aug 21, 2023

allroundexperts commented Aug 21, 2023

Piotrfj commented Aug 22, 2023

allroundexperts commented Aug 29, 2023

Piotrfj commented Aug 31, 2023

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron commented Sep 6, 2023

marcaaron commented Sep 14, 2023

allroundexperts commented Sep 14, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

allroundexperts commented Sep 14, 2023

marcaaron left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

Piotrfj commented Jul 18, 2023 •

edited

Loading

github-actions bot commented Jul 18, 2023 •

edited

Loading

gedu Jul 19, 2023 •

edited

Loading

gedu Jul 19, 2023 •

edited

Loading

rezkiy37 Jul 19, 2023 •

edited

Loading

fabioh8010 Jul 24, 2023 •

edited

Loading