[No QA] Add unit test for report should not be displayed in LHN

tests/ui/LHNItemsPresence.tsx

@@ -3,9 +3,11 @@ import type {ComponentType} from 'react';
 import Onyx from 'react-native-onyx';
 import type {WithCurrentUserPersonalDetailsProps} from '@components/withCurrentUserPersonalDetails';
 import * as Localize from '@libs/Localize';
+import * as ReportUtils from '@libs/ReportUtils';
+import * as TransactionUtils from '@libs/TransactionUtils';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {PersonalDetailsList} from '@src/types/onyx';
+import type {PersonalDetailsList, Report, ReportAction} from '@src/types/onyx';
 import type {ReportCollectionDataSet} from '@src/types/onyx/Report';
 import * as LHNTestUtils from '../utils/LHNTestUtils';
 import * as TestHelper from '../utils/TestHelper';
@@ -204,5 +206,140 @@ describe('SidebarLinksData', () => {
             // Then the empty report should not appear in the sidebar.
             expect(getOptionRows()).toHaveLength(0);
         });
+
+        it('should not display the report marked as hidden', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const report: Report = {
+                ...createReport(),
+                participants: {
+                    [TEST_USER_ACCOUNT_ID]: {
+                        notificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN,
+                    },
+                },
+            };
+
+            // And a report marked as hidden is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]: report,
+            });
+
+            // Then hidden report should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });
+
+        it('should not display the report the user cannot access due to policy restrictions', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const report: Report = {
+                ...createReport(),
+                chatType: CONST.REPORT.CHAT_TYPE.DOMAIN_ALL,
+                lastMessageText: 'fake last message',
+            };
+
+            // A default room is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]: report,
+            });
+
+            // And the defaultRooms beta is removed
+            await Onyx.merge(ONYXKEYS.BETAS, []);
+
+            // The default room should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });
+
+        it('should not display the single transaction thread', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const expenseReport = ReportUtils.buildOptimisticExpenseReport('212', '123', 100, 122, 'USD');
+            const expenseTransaction = TransactionUtils.buildOptimisticTransaction(100, 'USD', expenseReport.reportID);
+            const expenseCreatedAction = ReportUtils.buildOptimisticIOUReportAction(
+                'create',
+                100,
+                'USD',
+                '',
+                [],
+                expenseTransaction.transactionID,
+                undefined,
+                expenseReport.reportID,
+                undefined,
+                false,
+                false,
+                undefined,
+                undefined,
+            );
+            const transactionThreadReport = ReportUtils.buildTransactionThread(expenseCreatedAction, expenseReport);
+            expenseCreatedAction.childReportID = transactionThreadReport.reportID;
+
+            // A single transaction thread is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${transactionThreadReport.reportID}`]: transactionThreadReport,
+            });
+
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${expenseReport.reportID}`, expenseReport);
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${expenseReport.reportID}`, {
+                [expenseCreatedAction.reportActionID]: expenseCreatedAction,
+            });
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION}${expenseTransaction.transactionID}`, expenseTransaction);
+
+            // This report should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });
+
+        it('should not display the report with parent message is pending removal', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const parentReport = createReport();
+            const report = createReport();
+            const parentReportAction: ReportAction = {
+                ...LHNTestUtils.getFakeReportAction(),
+                message: [
+                    {
+                        type: 'COMMENT',
+                        html: 'hey',
+                        text: 'hey',
+                        isEdited: false,
+                        whisperedTo: [],
+                        isDeletedParentAction: false,
+                        moderationDecision: {
+                            decision: CONST.MODERATION.MODERATOR_DECISION_PENDING_REMOVE,
+                        },
+                    },
+                ],
+                childReportID: report.reportID,
+            };
+            report.parentReportID = parentReport.reportID;
+            report.parentReportActionID = parentReportAction.reportActionID;
+
+            // And a report with parent message is pending removal is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]: report,
+            });
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${parentReport.reportID}`, parentReport);
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReport.reportID}`, {
+                [parentReportAction.reportActionID]: parentReportAction,
+            });
+
+            // This report should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });
+
+        it('should not display the read report in the focus mode', async () => {
+            // When the SidebarLinks are rendered.
+            LHNTestUtils.getDefaultRenderedSidebarLinks();
+            const report = createReport();
+
+            // A read report is initialized in Onyx
+            await initializeState({
+                [`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]: report,
+            });
+
+            // And we are in the focus mode
+            await Onyx.merge(ONYXKEYS.NVP_PRIORITY_MODE, CONST.PRIORITY_MODE.GSD);
+
+            // This report should not appear in the sidebar.
+            expect(getOptionRows()).toHaveLength(0);
+        });
     });
 });

tests/unit/ReportUtilsTest.ts

@@ -4,9 +4,10 @@ import type {OnyxEntry} from 'react-native-onyx';
 import Onyx from 'react-native-onyx';
 import DateUtils from '@libs/DateUtils';
 import * as ReportUtils from '@libs/ReportUtils';
+import * as TransactionUtils from '@libs/TransactionUtils';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
-import type {PersonalDetailsList, Policy, Report, ReportAction} from '@src/types/onyx';
+import type {Beta, PersonalDetailsList, Policy, Report, ReportAction} from '@src/types/onyx';
 import {toCollectionDataSet} from '@src/types/utils/CollectionDataSet';
 import * as NumberUtils from '../../src/libs/NumberUtils';
 import * as LHNTestUtils from '../utils/LHNTestUtils';
@@ -1179,5 +1180,165 @@ describe('ReportUtils', () => {
                 expect(ReportUtils.getGroupChatName(undefined, false, report)).toEqual('Eight, Five, Four, One, Seven, Six, Three, Two');
             });
         });
+
+        describe('shouldReportBeInOptionList tests', () => {
+            afterEach(() => Onyx.clear());
+
+            it('should return false when the report is marked as hidden', () => {
+                const report: Report = {
+                    ...LHNTestUtils.getFakeReport(),
+                    participants: {
+                        '1': {
+                            notificationPreference: CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN,
+                        },
+                    },
+                };
+                const currentReportId = '';
+                const isInFocusMode = true;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: false}),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report does not have participants', () => {
+                const report = LHNTestUtils.getFakeReport([]);
+                const currentReportId = '';
+                const isInFocusMode = true;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: false}),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report is the report that the user cannot access due to policy restrictions', () => {
+                const report: Report = {
+                    ...LHNTestUtils.getFakeReport(),
+                    chatType: CONST.REPORT.CHAT_TYPE.DOMAIN_ALL,
+                };
+                const currentReportId = '';
+                const isInFocusMode = false;
+                const betas: Beta[] = [];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: false}),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report is the single transaction thread', async () => {
+                const expenseReport = ReportUtils.buildOptimisticExpenseReport('212', '123', 100, 122, 'USD');
+                const expenseTransaction = TransactionUtils.buildOptimisticTransaction(100, 'USD', expenseReport.reportID);
+                const expenseCreatedAction = ReportUtils.buildOptimisticIOUReportAction(
+                    'create',
+                    100,
+                    'USD',
+                    '',
+                    [],
+                    expenseTransaction.transactionID,
+                    undefined,
+                    expenseReport.reportID,
+                    undefined,
+                    false,
+                    false,
+                    undefined,
+                    undefined,
+                );
+                const transactionThreadReport = ReportUtils.buildTransactionThread(expenseCreatedAction, expenseReport);
+                expenseCreatedAction.childReportID = transactionThreadReport.reportID;
+                const currentReportId = '1';
+                const isInFocusMode = false;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${expenseReport.reportID}`, expenseReport);
+                await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${expenseReport.reportID}`, {
+                    [expenseCreatedAction.reportActionID]: expenseCreatedAction,
+                });
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({
+                        report: transactionThreadReport,
+                        currentReportId,
+                        isInFocusMode,
+                        betas,
+                        policies: {},
+                        doesReportHaveViolations: false,
+                        excludeEmptyChats: false,
+                    }),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report is empty chat and the excludeEmptyChats setting is true', () => {
+                const report = LHNTestUtils.getFakeReport();
+                const currentReportId = '';
+                const isInFocusMode = false;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: true}),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the user’s email is domain-based and the includeDomainEmail is false', () => {
+                const report = LHNTestUtils.getFakeReport();
+                const currentReportId = '';
+                const isInFocusMode = false;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({
+                        report,
+                        currentReportId,
+                        isInFocusMode,
+                        betas,
+                        policies: {},
+                        doesReportHaveViolations: false,
+                        login: '[email protected]',
+                        excludeEmptyChats: false,
+                        includeDomainEmail: false,
+                    }),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report has the parent message is pending removal', async () => {
+                const parentReport = LHNTestUtils.getFakeReport();
+                const report = LHNTestUtils.getFakeReport();
+                const parentReportAction: ReportAction = {
+                    ...LHNTestUtils.getFakeReportAction(),
+                    message: [
+                        {
+                            type: 'COMMENT',
+                            html: 'hey',
+                            text: 'hey',
+                            isEdited: false,
+                            whisperedTo: [],
+                            isDeletedParentAction: false,
+                            moderationDecision: {
+                                decision: CONST.MODERATION.MODERATOR_DECISION_PENDING_REMOVE,
+                            },
+                        },
+                    ],
+                    childReportID: report.reportID,
+                };
+                report.parentReportID = parentReport.reportID;
+                report.parentReportActionID = parentReportAction.reportActionID;
+                const currentReportId = '';
+                const isInFocusMode = false;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+
+                await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${parentReport.reportID}`, parentReport);
+                await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReport.reportID}`, {
+                    [parentReportAction.reportActionID]: parentReportAction,
+                });
+
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: false}),
+                ).toBeFalsy();
+            });
+
+            it('should return false when the report is read and we are in the focus mode', () => {
+                const report = LHNTestUtils.getFakeReport();
+                const currentReportId = '';
+                const isInFocusMode = true;
+                const betas = [CONST.BETAS.DEFAULT_ROOMS];
+                expect(
+                    ReportUtils.shouldReportBeInOptionList({report, currentReportId, isInFocusMode, betas, policies: {}, doesReportHaveViolations: false, excludeEmptyChats: false}),
+                ).toBeFalsy();
+            });
+        });
     });
 });