Merge pull request Expensify#82664 from callstack-internal/perf/report-name-value-pairs-selectors

[No QA] perf: remove ReportNameValuePairs selectors

Author: mountiny

src/hooks/useParticipantsInvoiceReport.ts

@@ -1,34 +1,12 @@
-import {createReportNameValuePairsSelector} from '@selectors/ReportNameValuePairs';
 import {useMemo} from 'react';
 import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';
 import {isArchivedNonExpenseReport, isArchivedReport, isInvoiceRoom} from '@libs/ReportUtils';
-import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {Report, ReportNameValuePairs} from '@src/types/onyx';
+import type {Report} from '@src/types/onyx';
 import type {InvoiceReceiverType} from '@src/types/onyx/Report';
 import mapOnyxCollectionItems from '@src/utils/mapOnyxCollectionItems';
 import useOnyx from './useOnyx';
 
-type ReportNameValuePairsSelector = Pick<ReportNameValuePairs, 'private_isArchived'>;
-
-/*
- Since invoice chat rooms have `type === CONST.REPORT.TYPE.CHAT`,
- we filter on that value to minimize the number of rNVPs being subscribed to.
-*/
-const reportNameValuePairSelector = (reportNameValuePairs: OnyxEntry<ReportNameValuePairs>): ReportNameValuePairsSelector | undefined => {
-    if (reportNameValuePairs && 'type' in reportNameValuePairs && reportNameValuePairs?.type !== CONST.REPORT.TYPE.CHAT) {
-        return;
-    }
-    return (
-        reportNameValuePairs &&
-        ({
-            private_isArchived: reportNameValuePairs.private_isArchived,
-        } as ReportNameValuePairsSelector)
-    );
-};
-
-const reportNameValuePairsSelector = (reportNameValuePairs: OnyxCollection<ReportNameValuePairs>) => createReportNameValuePairsSelector(reportNameValuePairs, reportNameValuePairSelector);
-
 const reportSelector = (report: OnyxEntry<Report>): Report | undefined => {
     if (!report || !isInvoiceRoom(report)) {
         return;
@@ -41,9 +19,8 @@ const allInvoiceReportsSelector = (reports: OnyxCollection<Report>) => mapOnyxCo
 
 function useParticipantsInvoiceReport(receiverID: string | number | undefined, receiverType: InvoiceReceiverType, policyID?: string): OnyxEntry<Report> {
     const [allInvoiceReports] = useOnyx(ONYXKEYS.COLLECTION.REPORT, {canBeMissing: true, selector: allInvoiceReportsSelector});
-    const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}`, {
+    const [reportNameValuePairs] = useOnyx(ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS, {
         canBeMissing: true,
-        selector: reportNameValuePairsSelector,
     });
 
     const invoiceReport = useMemo(() => {

src/hooks/usePrivateIsArchivedMap.ts

@@ -1,22 +1,24 @@
-import type {PrivateIsArchivedMap} from '@selectors/ReportNameValuePairs';
-import {privateIsArchivedMapSelector} from '@selectors/ReportNameValuePairs';
 import ONYXKEYS from '@src/ONYXKEYS';
-import {getEmptyObject} from '@src/types/utils/EmptyObject';
-import useDeepCompareRef from './useDeepCompareRef';
 import useOnyx from './useOnyx';
 
+type PrivateIsArchivedMap = Record<string, string | undefined>;
+
 /**
  * Hook that returns a map of report IDs to their private_isArchived values
  */
 function usePrivateIsArchivedMap(): PrivateIsArchivedMap {
-    const [privateIsArchivedMap = getEmptyObject<PrivateIsArchivedMap>()] = useOnyx(ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS, {
+    const [allReportNVP] = useOnyx(ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS, {
         canBeMissing: true,
-        selector: privateIsArchivedMapSelector,
     });
 
-    // useDeepCompareRef prevents unnecessary rerenders when the object has same content but different reference.
-    // The selector always returns a new object instance, and useMemo cannot compare by value.
-    return useDeepCompareRef(privateIsArchivedMap) ?? {};
+    const map: PrivateIsArchivedMap = {};
+    if (allReportNVP) {
+        for (const [key, value] of Object.entries(allReportNVP)) {
+            map[key] = value?.private_isArchived;
+        }
+    }
+    return map;
 }
 
 export default usePrivateIsArchivedMap;
+export type {PrivateIsArchivedMap};

src/libs/OptionsListUtils/index.ts

@@ -149,7 +149,7 @@ import {isScanning} from '@libs/TransactionUtils';
 import {generateAccountID} from '@libs/UserUtils';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {PrivateIsArchivedMap} from '@src/selectors/ReportNameValuePairs';
+import type {PrivateIsArchivedMap} from '@hooks/usePrivateIsArchivedMap';
 import type {
     Beta,
     DismissedProductTraining,

src/selectors/ReportNameValuePairs.ts

@@ -1,6 +1,6 @@
 import {rand} from '@ngneat/falso';
 import type * as NativeNavigation from '@react-navigation/native';
-import type {PrivateIsArchivedMap} from '@selectors/ReportNameValuePairs';
+import type {PrivateIsArchivedMap} from '@hooks/usePrivateIsArchivedMap';
 import Onyx from 'react-native-onyx';
 import {measureFunction} from 'reassure';
 import {createOptionList, filterAndOrderOptions, getMemberInviteOptions, getSearchOptions, getValidOptions} from '@libs/OptionsListUtils';

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

@@ -1,5 +1,5 @@
 import type * as NativeNavigation from '@react-navigation/native';
-import type {PrivateIsArchivedMap} from '@selectors/ReportNameValuePairs';
+import type {PrivateIsArchivedMap} from '@hooks/usePrivateIsArchivedMap';
 import {fireEvent, screen} from '@testing-library/react-native';
 import React, {useMemo} from 'react';
 import Onyx from 'react-native-onyx';

tests/perf-test/SearchRouter.perf-test.tsx

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {PrivateIsArchivedMap} from '@selectors/ReportNameValuePairs';
+import type {PrivateIsArchivedMap} from '@hooks/usePrivateIsArchivedMap';
 import {act, render, renderHook} from '@testing-library/react-native';
 import {View} from 'react-native';
 import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';

tests/unit/OptionsListUtilsTest.tsx

@@ -0,0 +1,81 @@
+import {act, renderHook} from '@testing-library/react-native';
+import Onyx from 'react-native-onyx';
+import usePrivateIsArchivedMap from '@hooks/usePrivateIsArchivedMap';
+import ONYXKEYS from '@src/ONYXKEYS';
+import waitForBatchedUpdatesWithAct from '../utils/waitForBatchedUpdatesWithAct';
+
+const REPORT_ID_1 = 'report_1';
+const REPORT_ID_2 = 'report_2';
+const REPORT_ID_3 = 'report_3';
+const ARCHIVED_DATE = '2024-01-15';
+const SECOND_ARCHIVED_DATE = '2024-03-22';
+
+describe('usePrivateIsArchivedMap', () => {
+    beforeEach(() => {
+        Onyx.init({keys: ONYXKEYS});
+    });
+
+    afterEach(async () => {
+        await act(async () => {
+            await Onyx.clear();
+        });
+        await waitForBatchedUpdatesWithAct();
+    });
+
+    it('returns an empty map when no report name value pairs are set', () => {
+        const {result} = renderHook(() => usePrivateIsArchivedMap());
+        expect(result.current).toEqual({});
+    });
+
+    it('maps report keys to their private_isArchived values', async () => {
+        await act(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`, {private_isArchived: ARCHIVED_DATE});
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_2}`, {private_isArchived: SECOND_ARCHIVED_DATE});
+        });
+
+        const {result} = renderHook(() => usePrivateIsArchivedMap());
+
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`]).toBe(ARCHIVED_DATE);
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_2}`]).toBe(SECOND_ARCHIVED_DATE);
+    });
+
+    it('returns undefined for reports that are not archived', async () => {
+        await act(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_3}`, {origin: 'email'});
+        });
+
+        const {result} = renderHook(() => usePrivateIsArchivedMap());
+
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_3}`]).toBeUndefined();
+    });
+
+    it('updates the map when Onyx data changes', async () => {
+        await act(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`, {origin: 'email'});
+        });
+
+        const {result} = renderHook(() => usePrivateIsArchivedMap());
+
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`]).toBeUndefined();
+
+        await act(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`, {private_isArchived: ARCHIVED_DATE});
+        });
+
+        await waitForBatchedUpdatesWithAct();
+
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`]).toBe(ARCHIVED_DATE);
+    });
+
+    it('handles a mix of archived and non-archived reports', async () => {
+        await act(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`, {private_isArchived: ARCHIVED_DATE});
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_2}`, {origin: 'email'});
+        });
+
+        const {result} = renderHook(() => usePrivateIsArchivedMap());
+
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_1}`]).toBe(ARCHIVED_DATE);
+        expect(result.current[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${REPORT_ID_2}`]).toBeUndefined();
+    });
+});