Migrate NewChatPage to functional component #20170

Nikhil-Vats · 2023-06-05T14:01:23Z

Details

Migrate NewChatPage to functional component

Fixed Issues

$ #16239

Tests

Individual chat -

Click on FAB.
Click on new chat.
Click on any user. You should be redirected to the correct chat.
Search for a new user with a valid email or a valid phone number.
A new chat should open.

Group chat -

Click on FAB.
Click on new group chat.
Select more than 1 users.
Click on create group button.
A new group should be created it it didn't exist already.
Click on FAB and new group chat again.
Select 8 users.
You should see the message - "You've selected the maximum number (8) of participants."
Search for any user, there should be no change in UI, no search results since max participants are selected.
Unselect a user and the message should go away and the search results should appear.
Search for a new user with valid email/phone and click on create button.
You should be redirected to the group chat.

Verify that no errors appear in the JS console

Offline tests

Follow the same steps as above but in offline mode.

If the individual chat/group chat already existed then you should be redirected there.
If the chat/group didn't exist before then the chat should open up but the opacity should be less than 1.

QA Steps

Follow the same steps listed in the sections above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mWeb.chrome.mov

Mobile Web - Safari

mWeb.safari.mov

Desktop

desktop.mov

iOS

ios.mov

ios.offline.mov

Android

android1.mov

android2.mov

melvin-bot · 2023-06-05T14:01:57Z

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

Nikhil-Vats · 2023-06-05T14:43:21Z

src/pages/NewChatPage.js

+    );
+    const isOptionsDataReady = ReportUtils.isReportDataReady() && OptionsListUtils.isPersonalDetailsReady(props.personalDetails);
+
+    const sections = useMemo(() => {


I used useMemo here as it was also used here -

App/src/pages/tasks/TaskAssigneeSelectorModal.js

Line 124 in 156d099

const sections = useMemo(() => {

But I propose to remove it following the guidelines in React docs -

Optimizing with useMemo is only valuable in a few cases:

The calculation you’re putting in useMemo is noticeably slow, and its dependencies rarely change.

You pass it as a prop to a component wrapped in memo. You want to skip re-rendering if the value hasn’t changed. Memoization lets your component re-render only when dependencies aren’t the same.

The value you’re passing is later used as a dependency of some Hook. For example, maybe another useMemo calculation value depends on it. Or maybe you are depending on this value from useEffect.

2 and 3 are not applicable here. For the first point, the dependencies change often in our case which would anyway recalculate the value.

If you agree then we can remove it from TaskAssigneeSelectorModal too because another issue there is that it uses props as a dependency when it only uses props.translate during calculation -

App/src/pages/tasks/TaskAssigneeSelectorModal.js

Line 163 in 156d099

}, [filteredCurrentUserOption, filteredPersonalDetails, filteredRecentReports, filteredUserToInvite, props]);

discussion on useCallback, useMemo in slack

@aimane-chnaif I will remove useMemo here if you agree.

I think so. I don't see much benefit of performance improvement using useMemo here.

Nikhil-Vats · 2023-06-05T14:49:11Z

src/pages/NewChatPage.js

+        // 1. searchTerm - when searchTerm changes updateOptionsWithSearchTerm is called by OptionsSelector's onChangeText prop
+        // 2. updateOptionsWithSearchTerm - it will change its reference upon each rerender unnecessarily
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [props.reports, props.personalDetails]);


Only added these two dependencies based on the code in componentDidUpdate.

thienlnam · 2023-06-05T14:51:03Z

Reassigning due to #16239 (comment)

Nikhil-Vats · 2023-06-05T14:54:41Z

src/pages/NewChatPage.js


-    updateOptionsWithSearchTerm(searchTerm = '') {
+    const updateOptionsWithSearchTerm = (newSearchTerm = '') => {


I didn't wrap it in useCallback based on the guidelines in React docs -

Caching a function with useCallback is only valuable in a few cases:

You pass it as a prop to a component wrapped in memo. You want to skip re-rendering if the value hasn’t changed. Memoization lets your component re-render only if dependencies changed.

The function you’re passing is later used as a dependency of some Hook. For example, another function wrapped in useCallback depends on it, or you depend on this function from useEffect.

The first point is NA as OptionsSelector is not wrapped in memo so it will change anyway. The second point is NA since it is not a dependency of any hook.

Another reason is if we wrap it in useCallback then excludedGroupEmails has to be added as a dependency and it is not a state variable so it will refer to a new object in memory upon each rerender which would need another hook for memoization thus I think it's best not to add.

Please use function

@aimane-chnaif if I use function, eslint throws error -

saw your comment on slack

I will update the PR and only use function keyword when the function is not a prop.

didn't use function here as it was passed down as prop

Nikhil-Vats · 2023-06-05T18:46:54Z

src/pages/NewChatPage.js

-     */
-    getSections(maxParticipantsReached) {
-        const sections = [];
+function NewChatPage(props) {


using function based on the discussion here

thienlnam · 2023-06-07T13:46:47Z

Merge conflicts and need to run prettier

Slight bump @aimane-chnaif

Nikhil-Vats · 2023-06-07T15:09:58Z

@thienlnam fixed both.

aimane-chnaif · 2023-06-07T15:10:42Z

reviewing now

Nikhil-Vats · 2023-06-09T12:15:55Z

@aimane-chnaif friendly bump :)

aimane-chnaif · 2023-06-14T10:49:45Z

src/pages/NewChatPage.js


    /**
     * Creates a new 1:1 chat with the option and the current user,
     * or navigates to the existing chat if one with those participants already exists.
     *
     * @param {Object} option
     */
-    createChat(option) {
+    const createChat = (option) => {


aimane-chnaif · 2023-06-14T10:49:51Z

src/pages/NewChatPage.js


    /**
     * Creates a new group chat with all the selected options and the current user,
     * or navigates to the existing chat if one with those participants already exists.
     */
-    createGroup() {
-        if (!this.props.isGroupChat) {
+    const createGroup = () => {


didn't use function here as it was passed down as prop

aimane-chnaif · 2023-06-14T10:51:08Z

src/pages/NewChatPage.js

-    toggleOption(option) {
-        this.setState((prevState) => {
-            const isOptionInList = _.some(prevState.selectedOptions, (selectedOption) => selectedOption.login === option.login);
+    const toggleOption = (option) => {


Nikhil-Vats · 2023-06-15T10:26:39Z

Hey @aimane-chnaif, updated the PR as per your feedback.

aimane-chnaif · 2023-06-20T14:30:28Z

@Nikhil-Vats lint failing

Nikhil-Vats · 2023-06-20T14:31:48Z

@aimane-chnaif fixed.

aimane-chnaif · 2023-06-20T19:04:41Z

I don't see any useCallback, useMemo for optimization.

aimane-chnaif · 2023-06-20T19:13:23Z

It's recommended to follow the guidance in the React documentation and add the optimization only if necessary. If it's not obvious why such an optimization (i.e. useCallback() or useMemo()) would be used, leave a code comment explaining the reasoning to aid reviewers and future contributors.

Nikhil-Vats · 2023-06-20T19:18:30Z

@aimane-chnaif
Explained here and here

aimane-chnaif · 2023-06-20T19:31:55Z

@Nikhil-Vats please check ReportDetailsPage or any other functional component how those are used.
Reviewing component in this PR, anyone thinks React introduced useEffect or useMemo for nothing.

It's recommended to follow the guidance in the React documentation and add the optimization only if necessary. If it's not obvious why such an optimization (i.e. useCallback() or useMemo()) would be used, leave a code comment explaining the reasoning to aid reviewers and future contributors.

We can avoid props as dependency but just add comment:

However, there are some cases where we might actually only want to re-run the effect when only some of those dependencies change. We determined the best practice here should be to allow disabling the “next line” with a comment //eslint-disable-next-line react-hooks/exhaustive-deps and an additional comment explanation so the next developer can understand why the rule was not used.

Nikhil-Vats · 2023-06-20T19:40:31Z

ok so as you said here that useMemo won't be very useful here. For useCallback, react docs says that -

Caching a function with useCallback is only valuable in a few cases:

You pass it as a prop to a component wrapped in memo. You want to skip re-rendering if the value hasn’t changed. Memoization lets your component re-render only if dependencies changed.

The function you’re passing is later used as a dependency of some Hook. For example, another function wrapped in useCallback depends on it, or you depend on this function from useEffect.

None of these is applicable here that's why I didn't wrap it in useCallback.

What do you think? Should I add useMemo/useCallback?

aimane-chnaif · 2023-06-20T19:45:11Z

@thienlnam what is your suggestion of whether to use useCallback/useMemo or not?

thienlnam · 2023-06-21T17:13:23Z

Let's go with useMemo - yes there are only a few cases where it makes a difference and there might not be a huge difference here, but this case applies

The calculation you’re putting in useMemo is noticeably slow, and its dependencies rarely change.

and so we don't want it to continually recalculate on each re-render

Nikhil-Vats · 2023-06-21T17:53:46Z

@aimane-chnaif @thienlnam added useMemo for calculating sections.

aimane-chnaif · 2023-06-25T14:23:25Z

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

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

android2.mov

aimane-chnaif · 2023-06-25T14:37:37Z

I think we can remove newSearchTerm and deprecate updateOptionsWithSearchTerm and use useEffect instead.

    useEffect(() => {
        const {recentReports, personalDetails, userToInvite} = OptionsListUtils.getNewChatOptions(
            props.reports,
            props.personalDetails,
            props.betas,
            searchTerm,
            [],
            props.isGroupChat ? excludedGroupEmails : [],
        );
        setFilteredRecentReports(recentReports);
        setFilteredPersonalDetails(personalDetails);
        setFilteredUserToInvite(userToInvite);
    }, [props.reports, props.personalDetails, searchTerm]);

Here, the dependencies excluded are props.betas and props.isGroupChat which never change during full component lifecycle.

                            onChangeText={setSearchTerm}

And define this outside of component lifecycle:

const excludedGroupEmails = _.without(CONST.EXPENSIFY_EMAILS, CONST.EMAIL.CONCIERGE);

Nikhil-Vats · 2023-06-28T14:23:17Z

@aimane-chnaif PR updated as per your feedback.

aimane-chnaif

LGTM 🎉

thienlnam

Awesome, thank you!

OSBotify · 2023-07-03T19:32:10Z

✋ 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-07-05T17:32:02Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.37-0 🚀

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

OSBotify · 2023-07-07T10:37:28Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

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

Migrate NewChatPage to functional component

c7b9245

Nikhil-Vats requested a review from a team as a code owner June 5, 2023 14:01

melvin-bot bot requested review from stitesExpensify and removed request for a team June 5, 2023 14:01

fix linting issues

a357a85

Nikhil-Vats commented Jun 5, 2023

View reviewed changes

Nikhil-Vats mentioned this pull request Jun 5, 2023

[HOLD for payment 2023-07-14] [$250] Migrate NewChatPage.js to function component #16239

Closed

1 task

Nikhil-Vats commented Jun 5, 2023

View reviewed changes

thienlnam requested review from thienlnam and aimane-chnaif and removed request for stitesExpensify June 5, 2023 14:50

Nikhil-Vats commented Jun 5, 2023

View reviewed changes

twisterdotcom assigned Nikhil-Vats Jun 5, 2023

use function instead of const

13d2e60

Nikhil-Vats commented Jun 5, 2023

View reviewed changes

Nikhil-Vats added 2 commits June 7, 2023 20:33

Merge branch 'main' into 16239_refactor_NewChatPage

8351d34

fix linting issues

a75802f

aimane-chnaif reviewed Jun 14, 2023

View reviewed changes

Change const to function

8115857

Nikhil-Vats added 2 commits June 20, 2023 19:48

Merge branch 'main' into 16239_refactor_NewChatPage

51cb0b8

Fix wrongly merged code

f213e8f

fix lint

80a9a9b

Use useMemo hook

56b5491

Remove updateOptionsWithSearchTerm and use useEffect

faf1a01

aimane-chnaif approved these changes Jun 29, 2023

View reviewed changes

thienlnam approved these changes Jul 3, 2023

View reviewed changes

thienlnam merged commit 79922cc into Expensify:main Jul 3, 2023

OSBotify mentioned this pull request Jul 5, 2023

Deploy Checklist: New Expensify 2023-07-05 #22282

Closed

58 tasks


		updateOptionsWithSearchTerm(searchTerm = '') {
		const updateOptionsWithSearchTerm = (newSearchTerm = '') => {

Migrate NewChatPage to functional component #20170

Migrate NewChatPage to functional component #20170

Conversation

Nikhil-Vats commented Jun 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 5, 2023

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

thienlnam commented Jun 5, 2023

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

Nikhil-Vats Jun 5, 2023 • edited Loading

Choose a reason for hiding this comment

thienlnam commented Jun 7, 2023

Nikhil-Vats commented Jun 7, 2023

aimane-chnaif commented Jun 7, 2023

Nikhil-Vats commented Jun 9, 2023

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

Nikhil-Vats commented Jun 15, 2023

aimane-chnaif commented Jun 20, 2023

Nikhil-Vats commented Jun 20, 2023

aimane-chnaif commented Jun 20, 2023

aimane-chnaif commented Jun 20, 2023

Nikhil-Vats commented Jun 20, 2023

aimane-chnaif commented Jun 20, 2023

Nikhil-Vats commented Jun 20, 2023 • edited Loading

aimane-chnaif commented Jun 20, 2023

thienlnam commented Jun 21, 2023

Nikhil-Vats commented Jun 21, 2023

aimane-chnaif commented Jun 25, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Jun 25, 2023

Nikhil-Vats commented Jun 28, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 3, 2023

OSBotify commented Jul 5, 2023

OSBotify commented Jul 7, 2023

Nikhil-Vats commented Jun 5, 2023 •

edited

Loading

Nikhil-Vats Jun 5, 2023 •

edited

Loading

Nikhil-Vats commented Jun 20, 2023 •

edited

Loading