Move the logic of excluding contacts of DMs already included in reports to `filterOptions` #50426

c3024 · 2024-10-08T14:52:02Z

Details

Presently, getOptions excludes the contacts of DM reports included in recentReports. These are reduced to 5 recent reports in the participant selection page of "Submit Expense" flow if we pass a maxRecentReportsToShow to filterOptions. Because the contacts of these DM reports are excluded already in getOptions, these do not appear in the "Contacts" section. The logic of exclusion of Contacts for reports added in recent reports is moved from getOptions to filterOptions to fix this issue.

Fixed Issues

$ #48114
PROPOSAL: #48114 (comment)

Tests

[Pre-requisite]: Login an account with more than 5 (say 10 DM) reports.

Test 1:

Click on FAB > "Submit Expense" > "Manual" > Input any amount > "Next"
Do not input anything in the search box yet
Verify that
-- there are 5 recent reports in "Recents" section
-- all contacts of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM shown in "Recents" section is not shown in "Contacts" section
Input a search term
Verify that
-- there are 5 recent reports matching with the search term in "Recents" section
-- all contacts (matching with the search term) of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM report matching with the search term shown in "Recents" section is not shown in "Contacts" section

Test 2:

Click on FAB > "Start Chat"
Follow steps 2 to 5 of Test 1 and verify the results

Test 3:

Go to any DM report
Click on "+" in composer > "Assign task"
Input title > "Next"
Follow steps 2 to 5 of Test 1 and verify the results

Test 4:

Click on "Settings" > "Workspaces" > Click on any workspace > "Members" > "Invite Member"
Verify that all "Contacts" are shown in options
Input a text in the search input
Verify that "Contacts" matching with the search term are shown in the options

Verify that no errors appear in the JS console

Offline tests

[Pre-requisite]: Login an account with more than 5 (say 10 DM) reports.

Test 1:

Click on FAB > "Submit Expense" > "Manual" > Input any amount > "Next"
Do not input anything in the search box yet
Verify that
-- there are 5 recent reports in "Recents" section
-- all contacts of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM shown in "Recents" section is not shown in "Contacts" section
Input a search term
Verify that
-- there are 5 recent reports matching with the search term in "Recents" section
-- all contacts (matching with the search term) of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM report matching with the search term shown in "Recents" section is not shown in "Contacts" section

Test 2:

Click on FAB > "Start Chat"
Follow steps 2 to 5 of Test 1 and verify the results

Test 3:

Go to any DM report
Click on "+" in composer > "Assign task"
Input title > "Next"
Follow steps 2 to 5 of Test 1 and verify the results

Test 4:

Click on "Settings" > "Workspaces" > Click on any workspace > "Members" > "Invite Member"
Verify that all "Contacts" are shown in options
Input a text in the search input
Verify that "Contacts" matching with the search term are shown in the options

QA Steps

[Pre-requisite]: Login an account with more than 5 (say 10 DM) reports.

Test 1:

Click on FAB > "Submit Expense" > "Manual" > Input any amount > "Next"
Do not input anything in the search box yet
Verify that
-- there are 5 recent reports in "Recents" section
-- all contacts of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM shown in "Recents" section is not shown in "Contacts" section
Input a search term
Verify that
-- there are 5 recent reports matching with the search term in "Recents" section
-- all contacts (matching with the search term) of DMs not included in the "Recents" section are included in the "Contacts" section
-- contact of any DM report matching with the search term shown in "Recents" section is not shown in "Contacts" section

Test 2:

Click on FAB > "Start Chat"
Follow steps 2 to 5 of Test 1 and verify the results

Test 3:

Go to any DM report
Click on "+" in composer > "Assign task"
Input title > "Next"
Follow steps 2 to 5 of Test 1 and verify the results

Test 4:

Click on "Settings" > "Workspaces" > Click on any workspace > "Members" > "Invite Member"
Verify that all "Contacts" are shown in options
Input a text in the search input
Verify that "Contacts" matching with the search term are shown in the options

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

filterAndroid1.mp4

filterAndroid2.mp4

filterAndroid3.mp4

Android: mWeb Chrome

filterAndroidmWeb.mp4

iOS: Native

filteriOS.mp4

iOS: mWeb Safari

filteriOSmWeb.mp4

MacOS: Chrome / Safari

filterChrome.mp4

MacOS: Desktop

filterDesktop.mp4

melvin-bot · 2024-10-09T16:02:15Z

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

eh2077 · 2024-10-10T13:38:05Z

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

0-android.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Submit expense

Assign task

Workspace invite page

New chat

Chat with search value

MacOS: Desktop

0-desktop.mp4

eh2077

Tested various cases and all look good. Just a comment worrying about possible performance downgrade.

eh2077 · 2024-10-10T14:44:21Z

src/libs/OptionsListUtils.ts

@@ -2569,9 +2574,10 @@ function filterOptions(options: Options, searchInputValue: string, config?: Filt
    if (maxRecentReportsToShow > 0 && recentReports.length > maxRecentReportsToShow) {
        recentReports.splice(maxRecentReportsToShow);
    }
+    const filteredPersonalDetails = filteredPersonalDetailsOfRecentReports(recentReports, personalDetails);


Is there a use case when maxRecentReportsToShow = 0 and recentReports is a long list? If so, then it seems there will be a performance downgrade here. Wdyt?

It will but that might not be significant.

We iterate over all recentReports here for each search word.

App/src/libs/OptionsListUtils.ts

Lines 2520 to 2542 in 9d86f30

const recentReports = filterArrayByMatch(items.recentReports, term, (item) => {

const values: string[] = [];

if (item.text) {

values.push(item.text);

}

if (item.login) {

values.push(item.login);

values.push(item.login.replace(CONST.EMAIL_SEARCH_REGEX, ''));

}

if (item.isThread) {

if (item.alternateText) {

values.push(item.alternateText);

}

} else if (!!item.isChatRoom || !!item.isPolicyExpenseChat) {

if (item.subtitle) {

values.push(item.subtitle);

}

}

return uniqFast(values);

});

We iterate over the recentReports once more for this function filteredPersonalDetailsOfRecentReports.

Since, we pass searchTerm only to this function filterOptions and not getOptions, we need to do this exclusion of contacts only here.

eh2077

LGTM

MonilBhavsar

I am going to review it on Monday.
Should we add lint rule to prevent wrong usage of filterOptions() as we discussed?

c3024 · 2024-10-13T07:59:27Z

Should we add lint rule to prevent wrong usage of filterOptions() as we discussed?

I checked the .eslintrc.js. It does not have any such custom rules for functions. If we do this, this will be the first. So, I am wondering if there is a reason (perhaps complexity) for never using them till now.

We have two other options.

We can throw a console warning or error like this in getOptions

if (options && options.reports && options.reports.length !== 0 && searchInputValue) {
        console.error('getOptions: Do not provide searchInputValue when options.reports is not empty. Use the performant filterOptions to filter with searchInputValue.');
    }

We can modify the types to enforce either non-empty options or non-empty searchInputValue can only be passed to getOptions but not both of them.

MonilBhavsar · 2024-10-14T06:17:11Z

We can modify the types to enforce either non-empty options or non-empty searchInputValue can only be passed to getOptions but not both of them.

This sounds good, plus we can add a comment 👍
@eh2077 curious for your thoughts too

eh2077 · 2024-10-14T06:27:48Z

Yeah, I also agree - modifying types to achieve it sounds more viable 👍

MonilBhavsar · 2024-10-14T07:12:50Z

Thanks! Let's do it 👍

c3024 · 2024-10-14T15:20:03Z

I have not found a way to enforce the constraint in getOptions. However, I could enforce the constraint in getFilteredOptions.

Here is the branch with some files changed.

When we pass a search term in cases with reports or personal details (in the MoneyRequestParticipantsSelector file in the video), TypeScript complains.

In cases where they are not passed, we can pass a search term, and TypeScript does not complain (as seen in EditReportFieldDropdownPage in the video).

enforceEmptySearchTerm.mp4

This type modification can also make the usage of getFilteredOptions cleaner everywhere. However, this requires careful changes in the params of getFilteredOptions used at different places.

I think we should handle that in a separate PR so that if we make any mistakes, we can revert it easily.

eh2077 · 2024-10-16T10:26:00Z

@c3024 Thanks for the update! Is it possible to achieve what we want through function overloads? See https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads

c3024 · 2024-10-16T10:48:30Z

I did try with functional overloads with getOptions. Since, we do not directly use getOptions, I could not make it work to correctly enforce the searchInputValue as the empty string literal ''. By the time it passes from getFilteredOptions et al TypeScript starts treating it as a string and starts complaining.

eh2077 · 2024-10-16T13:13:03Z

This type modification can also make the usage of getFilteredOptions cleaner everywhere. However, this requires careful changes in the params of getFilteredOptions used at different places.

@c3024 Hmm, I think it's better to do this in this PR together because here we have good intention and willingness - prevent wrong usage and get cleaner codebase.

c3024 · 2024-10-16T16:09:13Z

There ya go! 🤞

eh2077

looks good, just minor comments

src/libs/OptionsListUtils.ts

eh2077 · 2024-10-17T14:37:04Z

src/pages/iou/request/MoneyRequestParticipantsSelector.tsx

-            (canUseP2PDistanceRequests || iouRequestType !== CONST.IOU.REQUEST_TYPE.DISTANCE) && !isCategorizeOrShareAction,
-            false,
-            false,
-            0,


maxRecentReportsToShow: 0 is missing

@c3024 Btw this is crucial missing 😂

Yea, my bad!

Done.

Screen.Recording.2024-10-17.at.9.04.48.PM.mov

eh2077

Retested it on web and works well!

@c3024 Thanks for your patience!

MonilBhavsar

Thanks for TS cleanup. Looks good!

tests/perf-test/OptionsListUtils.perf-test.ts

tests/unit/OptionsListUtilsTest.ts

c3024 · 2024-10-18T12:16:55Z

@MonilBhavsar

Thanks for the comments. Updated with these suggestions.

I added a couple of comments in the last commit explaining why we are enforcing the types. Please have a look!

MonilBhavsar · 2024-10-18T12:49:39Z

Thank you for comments!

OSBotify · 2024-10-18T13:12:23Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-18T19:04:39Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.51-1 🚀

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

github-actions · 2024-10-22T04:37:55Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

github-actions · 2024-10-22T17:20:19Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

c3024 added 6 commits October 8, 2024 19:46

move report deduplicating logic to filterOptions

a50a4df

prettier and lint

deb1ba1

add missed filter case and fix tests

ffd08a4

extract filtering to function, fix lint in tests

68709d9

fix lint

b317a18

correct filtering logic for personal details

28b226d

c3024 marked this pull request as ready for review October 9, 2024 16:02

c3024 requested a review from a team as a code owner October 9, 2024 16:02

melvin-bot bot requested a review from eh2077 October 9, 2024 16:02

melvin-bot bot removed the request for review from a team October 9, 2024 16:02

eh2077 reviewed Oct 10, 2024

View reviewed changes

eh2077 approved these changes Oct 11, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar October 11, 2024 15:20

MonilBhavsar reviewed Oct 11, 2024

View reviewed changes

enforce empty search term with non-empty options

b69ea35

c3024 added 3 commits October 16, 2024 20:27

fix params for all getFilteredOptions calls

dfab13e

fix lint

dd001f4

migrate withOnyx to useOnyx

f9a76cf

eh2077 reviewed Oct 17, 2024

View reviewed changes

pass correct maxRecentReports to getFilteredOptions

63d5b19

eh2077 approved these changes Oct 18, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar October 18, 2024 00:28

MonilBhavsar reviewed Oct 18, 2024

View reviewed changes

c3024 added 2 commits October 18, 2024 17:11

review comments

3e72ecc

comments explaining need for types and function

0519359

MonilBhavsar approved these changes Oct 18, 2024

View reviewed changes

MonilBhavsar merged commit 0ec8b26 into Expensify:main Oct 18, 2024
16 checks passed

github-actions bot mentioned this pull request Oct 18, 2024

Deploy Checklist: New Expensify 2024-10-18 #51106

Closed

59 tasks

melvin-bot bot mentioned this pull request Oct 22, 2024

[HOLD for payment 2024-10-29] [$250] Submit Expense - Contacts section is missing participants #48114

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move the logic of excluding contacts of DMs already included in reports to `filterOptions` #50426

Move the logic of excluding contacts of DMs already included in reports to `filterOptions` #50426

c3024 commented Oct 8, 2024 •

edited

Loading

melvin-bot bot commented Oct 9, 2024

eh2077 commented Oct 10, 2024 •

edited

Loading

eh2077 left a comment

eh2077 Oct 10, 2024

c3024 Oct 10, 2024

eh2077 left a comment

MonilBhavsar left a comment

c3024 commented Oct 13, 2024

MonilBhavsar commented Oct 14, 2024

eh2077 commented Oct 14, 2024

MonilBhavsar commented Oct 14, 2024

c3024 commented Oct 14, 2024

eh2077 commented Oct 16, 2024

c3024 commented Oct 16, 2024

eh2077 commented Oct 16, 2024 •

edited

Loading

c3024 commented Oct 16, 2024

eh2077 left a comment

eh2077 Oct 17, 2024

eh2077 Oct 17, 2024

c3024 Oct 17, 2024

c3024 Oct 17, 2024

eh2077 left a comment

MonilBhavsar left a comment

c3024 commented Oct 18, 2024

MonilBhavsar commented Oct 18, 2024

OSBotify commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 22, 2024

github-actions bot commented Oct 22, 2024

	const recentReports = filterArrayByMatch(items.recentReports, term, (item) => {
	const values: string[] = [];
	if (item.text) {
	values.push(item.text);
	}

	if (item.login) {
	values.push(item.login);
	values.push(item.login.replace(CONST.EMAIL_SEARCH_REGEX, ''));
	}

	if (item.isThread) {
	if (item.alternateText) {
	values.push(item.alternateText);
	}
	} else if (!!item.isChatRoom \|\| !!item.isPolicyExpenseChat) {
	if (item.subtitle) {
	values.push(item.subtitle);
	}
	}

	return uniqFast(values);
	});

Move the logic of excluding contacts of DMs already included in reports to filterOptions #50426

Move the logic of excluding contacts of DMs already included in reports to filterOptions #50426

Conversation

c3024 commented Oct 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 9, 2024

eh2077 commented Oct 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

eh2077 Oct 10, 2024

Choose a reason for hiding this comment

c3024 Oct 10, 2024

Choose a reason for hiding this comment

eh2077 left a comment

Choose a reason for hiding this comment

MonilBhavsar left a comment

Choose a reason for hiding this comment

c3024 commented Oct 13, 2024

MonilBhavsar commented Oct 14, 2024

eh2077 commented Oct 14, 2024

MonilBhavsar commented Oct 14, 2024

c3024 commented Oct 14, 2024

eh2077 commented Oct 16, 2024

c3024 commented Oct 16, 2024

eh2077 commented Oct 16, 2024 • edited Loading

c3024 commented Oct 16, 2024

eh2077 left a comment

Choose a reason for hiding this comment

eh2077 Oct 17, 2024

Choose a reason for hiding this comment

eh2077 Oct 17, 2024

Choose a reason for hiding this comment

c3024 Oct 17, 2024

Choose a reason for hiding this comment

c3024 Oct 17, 2024

Choose a reason for hiding this comment

eh2077 left a comment

Choose a reason for hiding this comment

MonilBhavsar left a comment

Choose a reason for hiding this comment

c3024 commented Oct 18, 2024

MonilBhavsar commented Oct 18, 2024

OSBotify commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 22, 2024

github-actions bot commented Oct 22, 2024

Move the logic of excluding contacts of DMs already included in reports to `filterOptions` #50426

Move the logic of excluding contacts of DMs already included in reports to `filterOptions` #50426

c3024 commented Oct 8, 2024 •

edited

Loading

eh2077 commented Oct 10, 2024 •

edited

Loading

eh2077 commented Oct 16, 2024 •

edited

Loading