fix: add filtering to a group chat invite members #47051

TMisiukiewicz · 2024-08-08T10:10:18Z

Details

For the last couple of months we were migrating searchable lists from using searchText property , which was not a performant solution, to filtering based on options properties. Recently we migrated the last list that was still using searchText property for searching, so we removed generating it for search options, which allowed to speed up creating options by around 40%.

During migration, we accidentally skipped InviteReportParticipantsPage component, so once searchText property was removed from options, it was not possible to use search in this page. This PR brings filtering to the option list the same way it works on the other searchable pages.

Fixed Issues

$ #46972
PROPOSAL:

Tests

Go to FAB and create a new chat
Add at least two members to a group chat
Press the newly created chat title and go to Members
Go to Invite members
Check any of the options on the list
Type something in search that matches the item from the list
Verify it appears on the list
Type an email address in a search that does not belong to any account and verify it appears
Verify you can select it and add to group chat selection
Type some random string
Verify "no results found" is displayed

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Go to FAB and create a new chat
Add at least two members to a group chat
Press the newly created chat title and go to Members
Go to Invite members
Check any of the options on the list
Type something in search that matches the item from the list
Verify it appears on the list
Type an email address in a search that does not belong to any account and verify it appears
Verify you can select it and add to group chat selection
Type some random string
Verify "no results found" is displayed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

groupFiltering-android.mp4

Android: mWeb Chrome

https://github.com/user-attachments/assets/a439f5fd-6d52-4d1c-9029-966963995375

iOS: Native

groupFiltering-ios.mp4

iOS: mWeb Safari

groupFiltering-ios-web.mp4

MacOS: Chrome / Safari

groupFiltering-web.mp4

MacOS: Desktop

groupFiltering-dektop.mp4

melvin-bot · 2024-08-08T12:51:09Z

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

hoangzinh · 2024-08-08T15:00:33Z

Hi @TMisiukiewicz can you describe a little bit about the root cause in PR "Details" description so I can quickly pick up the issue? Thank you

TMisiukiewicz · 2024-08-08T15:14:01Z

@hoangzinh done!

hoangzinh · 2024-08-08T15:46:59Z

src/pages/InviteReportParticipantsPage.tsx

@@ -186,8 +192,8 @@ function InviteReportParticipantsPage({betas, personalDetails, report, didScreen
        ) {
            return translate('messages.userIsAlreadyMember', {login: searchValue, name: reportName ?? ''});
        }
-        return OptionsListUtils.getHeaderMessage(invitePersonalDetails.length !== 0, !!userToInvite, searchValue);
-    }, [searchTerm, userToInvite, excludedUsers, invitePersonalDetails, translate, reportName]);
+        return OptionsListUtils.getHeaderMessage(inviteOptions.recentReports.length + inviteOptions.personalDetails.length !== 0, !!inviteOptions.userToInvite, searchValue);


Can you explain why do we add "inviteOptions.recentReports.length" here?

Oh sorry for not mentioning about that, while working on this PR I found out that there is a tiny bug, when there were no results found in personal details, but there were items in recentReports, it displayed both "No results found" and list of recent options matching the search

With this change "No results found" will appear only when there is actually no items in both recentReports and personalDetails

hoangzinh · 2024-08-08T16:12:01Z

src/pages/InviteReportParticipantsPage.tsx

-        const inviteOptions = OptionsListUtils.getMemberInviteOptions(options.personalDetails, betas ?? [], searchTerm, excludedUsers, false, options.reports, true);
+    const defaultOptions = useMemo(() => {
+        if (!areOptionsInitialized) {
+            return {recentReports: [], personalDetails: [], userToInvite: null, currentUserOption: null, categoryOptions: [], tagOptions: [], taxRatesOptions: []};


I think it's worth to put this into a sharable function that returns an empty options object, what do you think?

hoangzinh · 2024-08-09T13:49:18Z

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

Screen.Recording.2024-08-09.at.20.53.45.android.mov

Android: mWeb Chrome

Screen.Recording.2024-08-09.at.20.43.05.android.chrome.mov

iOS: Native

Screen.Recording.2024-08-09.at.20.48.21.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-08-09.at.20.47.04.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-09.at.20.03.20.web.mov

MacOS: Desktop

Screen.Recording.2024-08-09.at.20.10.55.desktop.mov

marcochavezf

LGTM, thanks!

marcochavezf · 2024-08-12T18:00:02Z

Oh there are some conflicts

TMisiukiewicz · 2024-08-13T07:06:41Z

@marcochavezf resolved ✅

OSBotify · 2024-08-13T17:16:43Z

✋ 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-08-13T20:39:52Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 9.0.20-0 🚀

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

Beamanator · 2024-08-16T19:53:12Z

FYI I believe this was deployed to prod yesterday, from this checklist - #47356

add filtering to group chat

ee7a950

This was referenced Aug 8, 2024

Revert "Merge pull request #46409 from callstack-internal/perf/getsea… #46996

Closed

[HOLD for payment 2023-08-23] Group chat - Unable to search for members when inviting group members #46972

Closed

TMisiukiewicz marked this pull request as ready for review August 8, 2024 12:51

TMisiukiewicz requested a review from a team as a code owner August 8, 2024 12:51

melvin-bot bot requested a review from hoangzinh August 8, 2024 12:51

melvin-bot bot removed the request for review from a team August 8, 2024 12:51

hoangzinh reviewed Aug 8, 2024

View reviewed changes

move empty options object to util function

4c18c88

TMisiukiewicz requested a review from hoangzinh August 9, 2024 09:56

hoangzinh approved these changes Aug 9, 2024

View reviewed changes

melvin-bot bot requested a review from marcochavezf August 9, 2024 13:57

marcochavezf previously approved these changes Aug 12, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into fix/filter-group-chat

52edcc6

TMisiukiewicz dismissed marcochavezf’s stale review via 52edcc6 August 13, 2024 07:06

marcochavezf approved these changes Aug 13, 2024

View reviewed changes

marcochavezf merged commit c1cd62d into Expensify:main Aug 13, 2024
16 checks passed

github-actions bot mentioned this pull request Aug 13, 2024

Deploy Checklist: New Expensify 2024-08-13 #47356

Closed

72 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add filtering to a group chat invite members #47051

fix: add filtering to a group chat invite members #47051

TMisiukiewicz commented Aug 8, 2024 •

edited

Loading

melvin-bot bot commented Aug 8, 2024

hoangzinh commented Aug 8, 2024

TMisiukiewicz commented Aug 8, 2024

hoangzinh Aug 8, 2024

TMisiukiewicz Aug 9, 2024

hoangzinh Aug 8, 2024

TMisiukiewicz Aug 9, 2024

hoangzinh commented Aug 9, 2024 •

edited

Loading

marcochavezf left a comment

marcochavezf commented Aug 12, 2024

TMisiukiewicz commented Aug 13, 2024

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

fix: add filtering to a group chat invite members #47051

fix: add filtering to a group chat invite members #47051

Conversation

TMisiukiewicz commented Aug 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 8, 2024

hoangzinh commented Aug 8, 2024

TMisiukiewicz commented Aug 8, 2024

hoangzinh Aug 8, 2024

Choose a reason for hiding this comment

TMisiukiewicz Aug 9, 2024

Choose a reason for hiding this comment

hoangzinh Aug 8, 2024

Choose a reason for hiding this comment

TMisiukiewicz Aug 9, 2024

Choose a reason for hiding this comment

hoangzinh commented Aug 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

marcochavezf left a comment

Choose a reason for hiding this comment

marcochavezf commented Aug 12, 2024

TMisiukiewicz commented Aug 13, 2024

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

TMisiukiewicz commented Aug 8, 2024 •

edited

Loading

hoangzinh commented Aug 9, 2024 •

edited

Loading