rename getOptions -> getValidOptions

margelo · Nov 26, 2024 · 717d750 · 717d750
1 parent 8bb573f
commit 717d750
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 41 deletions.
diff --git a/src/components/Search/SearchFiltersParticipantsSelector.tsx b/src/components/Search/SearchFiltersParticipantsSelector.tsx
@@ -54,7 +54,7 @@ function SearchFiltersParticipantsSelector({initialAccountIDs, onFiltersUpdate}:
             return defaultListOptions;
         }
 
-        return OptionsListUtils.getOptions(
+        return OptionsListUtils.getValidOptions(
             {
                 reports: options.reports,
                 personalDetails: options.personalDetails,

diff --git a/src/libs/OptionsListUtils.ts b/src/libs/OptionsListUtils.ts
@@ -1061,11 +1061,10 @@ function getUserToInviteOption({
     return userToInvite;
 }
 
-// TODO: rename
 /**
- * filter options based on specific conditions
+ * Options are reports and personal details. This function filters out the options that are not valid to be displayed.
  */
-function getOptions(
+function getValidOptions(
     options: OptionList,
     {
         reportActions = {},
@@ -1311,7 +1310,7 @@ function getOptions(
 function getSearchOptions(options: OptionList, betas: Beta[] = [], isUsedInChatFinder = true): Options {
     Timing.start(CONST.TIMING.LOAD_SEARCH_OPTIONS);
     Performance.markStart(CONST.TIMING.LOAD_SEARCH_OPTIONS);
-    const optionList = getOptions(options, {
+    const optionList = getValidOptions(options, {
         betas,
         includeMultipleParticipantReports: true,
         showChatPreviewLine: isUsedInChatFinder,
@@ -1331,7 +1330,7 @@ function getSearchOptions(options: OptionList, betas: Beta[] = [], isUsedInChatF
 }
 
 function getShareLogOptions(options: OptionList, betas: Beta[] = []): Options {
-    return getOptions(options, {
+    return getValidOptions(options, {
         betas,
         includeMultipleParticipantReports: true,
         includeP2P: true,
@@ -1377,7 +1376,7 @@ function getAttendeeOptions(
     includeInvoiceRooms = false,
     action: IOUAction | undefined = undefined,
 ) {
-    return getOptions(
+    return getValidOptions(
         {reports, personalDetails},
         {
             betas,
@@ -1409,7 +1408,7 @@ function getShareDestinationOptions(
     includeOwnedWorkspaceChats = true,
     excludeUnknownUsers = true,
 ) {
-    return getOptions(
+    return getValidOptions(
         {reports, personalDetails},
         {
             betas,
@@ -1465,7 +1464,7 @@ function getMemberInviteOptions(
     reports: Array<SearchOption<Report>> = [],
     includeRecentReports = false,
 ): Options {
-    const options = getOptions(
+    const options = getValidOptions(
         {reports, personalDetails},
         {
             betas,
@@ -1784,7 +1783,7 @@ export {
     getAvatarsForAccountIDs,
     isCurrentUser,
     isPersonalDetailsReady,
-    getOptions,
+    getValidOptions,
     getSearchOptions,
     getShareDestinationOptions,
     getMemberInviteOptions,

diff --git a/src/pages/NewChatPage.tsx b/src/pages/NewChatPage.tsx
@@ -48,7 +48,7 @@ function useOptions() {
     });
 
     const defaultOptions = useMemo(() => {
-        const filteredOptions = OptionsListUtils.getOptions(
+        const filteredOptions = OptionsListUtils.getValidOptions(
             {
                 reports: listOptions.reports ?? [],
                 personalDetails: listOptions.personalDetails ?? [],

diff --git a/src/pages/iou/request/MoneyRequestParticipantsSelector.tsx b/src/pages/iou/request/MoneyRequestParticipantsSelector.tsx
@@ -105,7 +105,7 @@ function MoneyRequestParticipantsSelector({
             };
         }
 
-        const optionList = OptionsListUtils.getOptions(
+        const optionList = OptionsListUtils.getValidOptions(
             {
                 reports: options.reports,
                 personalDetails: options.personalDetails,

diff --git a/src/pages/settings/Security/AddDelegate/AddDelegatePage.tsx b/src/pages/settings/Security/AddDelegate/AddDelegatePage.tsx
@@ -27,7 +27,7 @@ function useOptions() {
     const existingDelegates = useMemo(() => account?.delegatedAccess?.delegates?.map((delegate) => delegate.email) ?? [], [account?.delegatedAccess?.delegates]);
 
     const defaultOptions = useMemo(() => {
-        const {recentReports, personalDetails, userToInvite, currentUserOption} = OptionsListUtils.getOptions(
+        const {recentReports, personalDetails, userToInvite, currentUserOption} = OptionsListUtils.getValidOptions(
             {
                 reports: optionsList.reports,
                 personalDetails: optionsList.personalDetails,

diff --git a/src/pages/tasks/TaskAssigneeSelectorModal.tsx b/src/pages/tasks/TaskAssigneeSelectorModal.tsx
@@ -40,7 +40,7 @@ function useOptions() {
     const {options: optionsList, areOptionsInitialized} = useOptionsList();
 
     const defaultOptions = useMemo(() => {
-        const {recentReports, personalDetails, userToInvite, currentUserOption} = OptionsListUtils.getOptions(
+        const {recentReports, personalDetails, userToInvite, currentUserOption} = OptionsListUtils.getValidOptions(
             {
                 reports: optionsList.reports,
                 personalDetails: optionsList.personalDetails,

diff --git a/tests/perf-test/OptionsListUtils.perf-test.ts b/tests/perf-test/OptionsListUtils.perf-test.ts
@@ -108,7 +108,7 @@ describe('OptionsListUtils', () => {
     test('[OptionsListUtils] getFilteredOptions with search value', async () => {
         await waitForBatchedUpdates();
         await measureFunction(() => {
-            const formattedOptions = OptionsListUtils.getOptions({reports: options.reports, personalDetails: options.personalDetails}, {betas: mockedBetas});
+            const formattedOptions = OptionsListUtils.getValidOptions({reports: options.reports, personalDetails: options.personalDetails}, {betas: mockedBetas});
             OptionsListUtils.filterAndOrderOptions(formattedOptions, SEARCH_VALUE);
         });
     });