New Chat page list refactor

[lukemorawski]

Details

This PR refactors the NewChatPage to use new component.
A new param has been added to to allow it to display a component on the right hand side of each list item. This param allows to pass a react node or a function that will render a component.

Fixed Issues

$ #20354
PROPOSAL: this PR (no proposal)

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• tap FAB on main screen and choose "Start Chat"
• tap on a contact to start a chat
• OR tap split on couple of contacts and start a chat
• OR search for contacts and tap on contact to start a chat
• OR search for contacts and tap split on couple of contact to start a chat
• observe if page behaves exactly the same as on staging
• 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 followed the guidelines as stated in the Review Guidelines
• 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 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 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.

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]

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

[rushatgabhane]

Bug: The checkbox doesn't work for users in contacts section.

1. Start chat
2. Input a value in search
3. For users that are in Contacts section, click Add to group

Expected: Checkbox is ticked
Actual: checkbox doesn't change its state.

Screen.Recording.2024-01-17.at.11.35.27.mov

[lukemorawski]

@rushatgabhane thank for that. Looks like it need the same change as here #34562

[rushatgabhane]

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-03-12.at.03.34.58.mov

Screen.Recording.2024-02-02.at.23.37.31.mov

iOS: mWeb Safari

Screen.Recording.2024-02-02.at.23.35.28.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-12.at.03.33.18.mov

MacOS: Desktop

[rushatgabhane]

@lukemorawski the same bug is present #34356 (review)

Screen.Recording.2024-01-26.at.18.22.40.mov

[lukemorawski]

@rushatgabhane honestly cannot replicate that issue. But did some more cleaning up.

new.chat.page.issue.mov

[lukemorawski]

@rushatgabhane kind bump

[rushatgabhane]

LGTM

[cristipaval]

Let's solve the conflicts please 🙏

[lukemorawski]

@cristipaval @rushatgabhane resolved conflicts with main but there are two questions/issues:

1. one of the conflicts was a new feature of dismissing the referral program banner. It was kinda oddly implemented. Instead of implementing the whole dismissing logic inside the <ReferralProgramCTA /> component, it was done by wrapping all of the instances of that component in a conditional expression and passing a onClose handler to it, with the same handle in case of every instance. What I did is I moved that logic inside the referral banner component. The thing is to refactor a bit all the instances of it in few places. Can I do it here (in this PR) or should it be done in a seperate PR?
2. another conflict was a use of a new hook useSearchTermAndSearch. It's suppose to streamline searching for a report on a server and prevent calling the API in case of maxParticipantsReached flag is true. The problem with that hook is that it's calling the API on every key stroke. I reverted it's use in this page component and added the max participants conditional to the old logic. The other way around would be to refactor that hook to use the useDebouncedState internally and act also as a search term state holder.
   What are your thoughts?

[cristipaval]

@cristipaval @rushatgabhane resolved conflicts with main but there are two questions/issues:

1. one of the conflicts was a new feature of dismissing the referral program banner. It was kinda oddly implemented. Instead of implementing the whole dismissing logic inside the <ReferralProgramCTA /> component, it was done by wrapping all of the instances of that component in a conditional expression and passing a onClose handler to it, with the same handle in case of every instance. What I did is I moved that logic inside the referral banner component. The thing is to refactor a bit all the instances of it in few places. Can I do it here (in this PR) or should it be done in a seperate PR?

I think a separate PR would be best.

2. another conflict was a use of a new hook useSearchTermAndSearch. It's suppose to streamline searching for a report on a server and prevent calling the API in case of maxParticipantsReached flag is true. The problem with that hook is that it's calling the API on every key stroke. I reverted it's use in this page component and added the max participants conditional to the old logic. The other way around would be to refactor that hook to use the useDebouncedState internally and act also as a search term state holder.
   What are your thoughts?

I think it's fine as you already did, because I'm not sure if the hook refactor would be always applicable where it is used.

@rushatgabhane any thoughts?

[rushatgabhane]

Can I do it here (in this PR) or should it be done in a seperate PR?

I think we should do it in this PR because the changes to ReferralCTA are already done in this PR. Now we just have to remove the onClose and surrounding code in all it's usages.

[rushatgabhane]

The other way around would be to refactor that hook to use the useDebouncedState internally and act also as a search term state holder

i think we should refactor the hook and debounce it internally. I don't see any cons with always debouncing search. cc: @cristipaval @lukemorawski what do you think?

[rushatgabhane]

@lukemorawski if both the changes are too big, feel free to close this PR and create seperate PRs.

[lukemorawski]

OK, so I think we could do it like that:

1. <ReferralProgramCTA /> - i'll merge main and refactor the components where it's used
2. I'll create a separate PR to refactor the useSearchTermAndSearch

[cristipaval]

Sounds like a plan!

[rushatgabhane]

@lukemorawski let us know if this is ready, thanks 🙇

[lukemorawski]

@rushatgabhane it's ready. I'll just prepare a second PR with useSearchTermAndSearch refactoring, but that's a separate thing.

[cristipaval]

@rushatgabhane could you please do the checklist for this one?

[rushatgabhane]

@cristipaval LGTM! updated the checklist

[OSBotify]

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

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

[luacmartins]

FYI @lukemorawski @cristipaval @rushatgabhane we reverted this PR since it caused the blockers below. Please consider this issues when working on v2 of the PR.

• [HOLD for payment 2024-03-22] [HOLD for payment 2024-03-20] Start chat - Contact list does not scroll back up after clicking Add to group #38173
• [HOLD for payment 2024-03-22] [HOLD for payment 2024-03-20] Start chat - Focus is not applied on the first user #38176
• [HOLD for payment 2024-03-22] [HOLD for payment 2024-03-20] Start chat - Contact list shows up after some delay with skeleton loading #38179
• [HOLD for payment 2024-04-15] [$500] Start chat - Chat RHP switches to Room tab when dragging input from right to left #38177
• [HOLD for payment 2024-03-22] [HOLD for payment 2024-03-20] Start chat - Selected members appear when the search query does not match the selected members #38181

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.51-3 🚀

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

[lukemorawski]

new PR here #38610