Clean implementation of heap used for recent reports list

Author: sosek108

src/components/Search/SearchAutocompleteList.tsx

@@ -18,7 +18,7 @@ import useThemeStyles from '@hooks/useThemeStyles';
 import {getCardFeedKey, getCardFeedNamesWithType} from '@libs/CardFeedUtils';
 import {getCardDescription, isCard, isCardHiddenFromSearch, mergeCardListWithWorkspaceFeeds} from '@libs/CardUtils';
 import memoize from '@libs/memoize';
-import {getMostRecentOptions, Options, SearchOption} from '@libs/OptionsListUtils';
+import {getMostRecentOptions, Options, recentReportComparator, SearchOption} from '@libs/OptionsListUtils';
 import {combineOrderingOfReportsAndPersonalDetails, getSearchOptions, getValidPersonalDetailOptions, orderReportOptions} from '@libs/OptionsListUtils';
 import Performance from '@libs/Performance';
 import {getAllTaxRates, getCleanedTagName, shouldShowPolicy} from '@libs/PolicyUtils';
@@ -353,14 +353,10 @@ function SearchAutocompleteList(
                 }));
             }
             case CONST.SEARCH.SYNTAX_FILTER_KEYS.IN: {
-                Timing.start(CONST.TIMING.SEARCH_MOST_RECENT_OPTIONS)
-
                 // const orderedReportOptions = orderReportOptions(searchOptions.recentReports);
-                const orderedReportOptions = getMostRecentOptions(searchOptions.recentReports, 10)
-                const filteredChats = orderedReportOptions
-                    .filter((chat) => chat.text?.toLowerCase()?.includes(autocompleteValue.toLowerCase()) && !alreadyAutocompletedKeys.includes(chat.text.toLowerCase()))
-                    .slice(0, 10);
-                Timing.end(CONST.TIMING.SEARCH_MOST_RECENT_OPTIONS)
+                const filterChats = (chat: OptionData) => chat.text?.toLowerCase()?.includes(autocompleteValue.toLowerCase()) && !alreadyAutocompletedKeys.includes(chat.text.toLowerCase());
+                const filteredChats = getMostRecentOptions(searchOptions.recentReports, 10, recentReportComparator, filterChats);
+
                 return filteredChats.map((chat) => ({
                     filterKey: CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS.IN,
                     text: chat.text ?? '',
@@ -501,12 +497,13 @@ function SearchAutocompleteList(
     const {search: filterOptions, isInitialized: isFastSearchInitialized} = useFastSearchFromOptions(searchOptions, {includeUserToInvite: true});
 
     const recentReportsOptions = useMemo(() => {
+        Timing.start(CONST.TIMING.SEARCH_FILTER_OPTIONS);
         if (autocompleteQueryValue.trim() === '' || !isFastSearchInitialized) {
-            const orderedReportOptions = orderReportOptions(searchOptions.recentReports);
-            return orderedReportOptions.slice(0, 20);
+            const orderedReportOptions = getMostRecentOptions(searchOptions.recentReports, 20, recentReportComparator);
+            Timing.end(CONST.TIMING.SEARCH_FILTER_OPTIONS);
+            return orderedReportOptions;
         }
 
-        Timing.start(CONST.TIMING.SEARCH_FILTER_OPTIONS);
         const filteredOptions = filterOptions(autocompleteQueryValue);
         const orderedOptions = combineOrderingOfReportsAndPersonalDetails(filteredOptions, autocompleteQueryValue, {
             sortByReportTypeInSearch: true,

src/libs/OptionsListUtils.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/prefer-for-of */
 
 /* eslint-disable no-continue */
+import {MaxHeap} from '@datastructures-js/heap';
 import {Str} from 'expensify-common';
 import keyBy from 'lodash/keyBy';
 import lodashOrderBy from 'lodash/orderBy';
@@ -144,7 +145,6 @@ import type {OptionData} from './ReportUtils';
 import StringUtils from './StringUtils';
 import {getTaskCreatedMessage, getTaskReportActionMessage} from './TaskUtils';
 import {generateAccountID} from './UserUtils';
-import {MaxHeap} from '@datastructures-js/heap';
 
 type SearchOption<T> = OptionData & {
     item: T;
@@ -1253,18 +1253,28 @@ function orderReportOptions(options: OptionData[]) {
     return lodashOrderBy(options, [sortComparatorReportOptionByArchivedStatus, sortComparatorReportOptionByDate], ['asc', 'desc']);
 }
 
-function getMostRecentOptions(options: OptionData[], limit: number): OptionData[] {
-    const heap = new MaxHeap<OptionData>((option) => {
-        return `${option.private_isArchived ? 0 : 1}_${option.lastVisibleActionCreated ?? ''}`;
-    });
+const recentReportComparator = (option: OptionData) => {
+    return `${option.private_isArchived ? 0 : 1}_${option.lastVisibleActionCreated ?? ''}`;
+};
+
+function getMostRecentOptions(options: OptionData[], limit: number, comparator: (option: OptionData) => number | string, filter?: (option: OptionData) => boolean | undefined): OptionData[] {
+    Timing.start(CONST.TIMING.SEARCH_MOST_RECENT_OPTIONS);
+    const heap = new MaxHeap<OptionData>(comparator);
     options.forEach((option) => {
+        if (filter && !filter(option)) {
+            return;
+        }
         heap.push(option);
     });
-    const result = [];
-    while (heap.size() > 0 && result.length < limit) {
-        result.push(heap.pop());
+    const result: OptionData[] = [];
+    while (!heap.isEmpty() && result.length < limit) {
+        /**
+         * Disable the no-non-null assertion rule here because we are checking if the heap is empty before popping an element.
+         */
+        /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+        result.push(heap.pop()!);
     }
-
+    Timing.end(CONST.TIMING.SEARCH_MOST_RECENT_OPTIONS);
     return result;
 }
 
@@ -2483,7 +2493,8 @@ export {
     isMakingLastRequiredTagListOptional,
     processReport,
     shallowOptionsListCompare,
-    getMostRecentOptions
+    getMostRecentOptions,
+    recentReportComparator,
 };
 
 export type {Section, SectionBase, MemberForList, Options, OptionList, SearchOption, Option, OptionTree, ReportAndPersonalDetailOptions};

src/pages/Share/ShareTab.tsx

@@ -12,7 +12,7 @@ import useThemeStyles from '@hooks/useThemeStyles';
 import {getOptimisticChatReport, saveReportDraft, searchInServer} from '@libs/actions/Report';
 import {saveUnknownUserDetails} from '@libs/actions/Share';
 import Navigation from '@libs/Navigation/Navigation';
-import {combineOrderingOfReportsAndPersonalDetails, getHeaderMessage, getSearchOptions, orderReportOptions} from '@libs/OptionsListUtils';
+import {combineOrderingOfReportsAndPersonalDetails, getHeaderMessage, getMostRecentOptions, getSearchOptions, recentReportComparator} from '@libs/OptionsListUtils';
 import type {OptionData} from '@libs/ReportUtils';
 import StringUtils from '@libs/StringUtils';
 import CONST from '@src/CONST';
@@ -52,8 +52,7 @@ function ShareTab() {
 
     const recentReportsOptions = useMemo(() => {
         if (textInputValue.trim() === '') {
-            const orderedReportOptions = orderReportOptions(searchOptions.recentReports);
-            return orderedReportOptions.slice(0, 20);
+            return getMostRecentOptions(searchOptions.recentReports, 20, recentReportComparator);
         }
         const filteredOptions = filterOptions(textInputValue);
         const orderedOptions = combineOrderingOfReportsAndPersonalDetails(filteredOptions, textInputValue, {