Merge pull request #46661 from ShridharGoel/chat_tests

[NoQA] Tests for group chat name

tests/ui/GroupChatNameTests.tsx

@@ -0,0 +1,342 @@
+/* eslint-disable testing-library/no-node-access */
+
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+import {act, render, screen, waitFor} from '@testing-library/react-native';
+import React from 'react';
+import Onyx from 'react-native-onyx';
+import * as Localize from '@libs/Localize';
+import * as AppActions from '@userActions/App';
+import * as User from '@userActions/User';
+import App from '@src/App';
+import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
+import type {Participant} from '@src/types/onyx/Report';
+import PusherHelper from '../utils/PusherHelper';
+import * as TestHelper from '../utils/TestHelper';
+import {navigateToSidebarOption} from '../utils/TestHelper';
+import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';
+import waitForBatchedUpdatesWithAct from '../utils/waitForBatchedUpdatesWithAct';
+
+// We need a large timeout here as we are lazy loading React Navigation screens and this test is running against the entire mounted App
+jest.setTimeout(50000);
+
+jest.mock('../../src/components/ConfirmedRoute.tsx');
+
+// Needed for: https://stackoverflow.com/questions/76903168/mocking-libraries-in-jest
+jest.mock('react-native/Libraries/LogBox/LogBox', () => ({
+    /* eslint-disable-next-line @typescript-eslint/naming-convention */
+    __esModule: true,
+    default: {
+        ignoreLogs: jest.fn(),
+        ignoreAllLogs: jest.fn(),
+    },
+}));
+
+/**
+ * We need to keep track of the transitionEnd callback so we can trigger it in our tests
+ */
+let transitionEndCB: () => void;
+
+jest.mock('@react-navigation/native');
+
+TestHelper.setupApp();
+
+const REPORT_ID = '1';
+const USER_A_ACCOUNT_ID = 1;
+const USER_A_EMAIL = '[email protected]';
+const USER_B_ACCOUNT_ID = 2;
+const USER_B_EMAIL = '[email protected]';
+const USER_C_ACCOUNT_ID = 3;
+const USER_C_EMAIL = '[email protected]';
+const USER_D_ACCOUNT_ID = 4;
+const USER_D_EMAIL = '[email protected]';
+const USER_E_ACCOUNT_ID = 5;
+const USER_E_EMAIL = '[email protected]';
+const USER_F_ACCOUNT_ID = 6;
+const USER_F_EMAIL = '[email protected]';
+const USER_G_ACCOUNT_ID = 7;
+const USER_G_EMAIL = '[email protected]';
+const USER_H_ACCOUNT_ID = 8;
+const USER_H_EMAIL = '[email protected]';
+
+/**
+ * Sets up a test with a logged in user. Returns the <App/> test instance.
+ */
+function signInAndGetApp(reportName = '', participantAccountIDs?: number[]): Promise<void> {
+    // Render the App and sign in as a test user.
+    render(<App />);
+
+    const participants: Record<number, Participant> = {};
+    participantAccountIDs?.forEach((id) => {
+        participants[id] = {
+            notificationPreference: 'always',
+            hidden: false,
+            role: id === 1 ? CONST.REPORT.ROLE.ADMIN : CONST.REPORT.ROLE.MEMBER,
+        } as Participant;
+    });
+
+    return waitForBatchedUpdatesWithAct()
+        .then(async () => {
+            await waitForBatchedUpdatesWithAct();
+            const hintText = Localize.translateLocal('loginForm.loginForm');
+            const loginForm = screen.queryAllByLabelText(hintText);
+            expect(loginForm).toHaveLength(1);
+
+            await act(async () => {
+                await TestHelper.signInWithTestUser(USER_A_ACCOUNT_ID, USER_A_EMAIL, undefined, undefined, 'A');
+            });
+            return waitForBatchedUpdatesWithAct();
+        })
+        .then(() => {
+            User.subscribeToUserEvents();
+            return waitForBatchedUpdates();
+        })
+        .then(async () => {
+            // Simulate setting an unread report and personal details
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`, {
+                reportID: REPORT_ID,
+                reportName,
+                lastMessageText: 'Test',
+                participants,
+                lastActorAccountID: USER_B_ACCOUNT_ID,
+                type: CONST.REPORT.TYPE.CHAT,
+                chatType: CONST.REPORT.CHAT_TYPE.GROUP,
+            });
+
+            await Onyx.merge(ONYXKEYS.PERSONAL_DETAILS_LIST, {
+                [USER_A_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_A_EMAIL, USER_A_ACCOUNT_ID, 'A'),
+                [USER_B_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_B_EMAIL, USER_B_ACCOUNT_ID, 'B'),
+                [USER_C_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_C_EMAIL, USER_C_ACCOUNT_ID, 'C'),
+                [USER_D_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_D_EMAIL, USER_D_ACCOUNT_ID, 'D'),
+                [USER_E_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_E_EMAIL, USER_E_ACCOUNT_ID, 'E'),
+                [USER_F_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_F_EMAIL, USER_F_ACCOUNT_ID, 'F'),
+                [USER_G_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_G_EMAIL, USER_G_ACCOUNT_ID, 'G'),
+                [USER_H_ACCOUNT_ID]: TestHelper.buildPersonalDetails(USER_H_EMAIL, USER_H_ACCOUNT_ID, 'H'),
+            });
+
+            // We manually setting the sidebar as loaded since the onLayout event does not fire in tests
+            AppActions.setSidebarLoaded();
+            return waitForBatchedUpdatesWithAct();
+        });
+}
+
+/**
+ * Tests for checking the group chat names at places like LHN, chat header, details page etc.
+ * Note that limit of 5 names is only for the header.
+ */
+describe('Tests for group chat name', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+        Onyx.clear();
+
+        // Unsubscribe to pusher channels
+        PusherHelper.teardown();
+    });
+
+    const participantAccountIDs4 = [USER_A_ACCOUNT_ID, USER_B_ACCOUNT_ID, USER_C_ACCOUNT_ID, USER_D_ACCOUNT_ID];
+    const participantAccountIDs8 = [...participantAccountIDs4, USER_E_ACCOUNT_ID, USER_F_ACCOUNT_ID, USER_G_ACCOUNT_ID, USER_H_ACCOUNT_ID];
+
+    it('Should show correctly in LHN', () =>
+        signInAndGetApp('A, B, C, D', participantAccountIDs4).then(() => {
+            // Verify the sidebar links are rendered
+            const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+            const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+            expect(sidebarLinks).toHaveLength(1);
+
+            // Verify there is only one option in the sidebar
+            const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+            const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+            expect(optionRows).toHaveLength(1);
+
+            const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+            const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+            return waitFor(() => expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D'));
+        }));
+
+    it('Should show correctly in LHN when report name is not present', () =>
+        signInAndGetApp('', participantAccountIDs4).then(() => {
+            // Verify the sidebar links are rendered
+            const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+            const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+            expect(sidebarLinks).toHaveLength(1);
+
+            // Verify there is only one option in the sidebar
+            const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+            const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+            expect(optionRows).toHaveLength(1);
+
+            const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+            const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+            return waitFor(() => expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D'));
+        }));
+
+    it('Should show limited names in LHN when 8 participants are present', () =>
+        signInAndGetApp('', participantAccountIDs8).then(() => {
+            // Verify the sidebar links are rendered
+            const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+            const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+            expect(sidebarLinks).toHaveLength(1);
+
+            // Verify there is only one option in the sidebar
+            const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+            const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+            expect(optionRows).toHaveLength(1);
+
+            const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+            const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+            return waitFor(() => expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D, E'));
+        }));
+
+    it('Check if group name shows fine for report header', () =>
+        signInAndGetApp('', participantAccountIDs4)
+            .then(() => {
+                // Verify the sidebar links are rendered
+                const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+                const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+                expect(sidebarLinks).toHaveLength(1);
+
+                // Verify there is only one option in the sidebar
+                const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+                const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+                expect(optionRows).toHaveLength(1);
+
+                const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+                const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+                expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D');
+
+                return navigateToSidebarOption(0);
+            })
+            .then(waitForBatchedUpdates)
+            .then(async () => {
+                await act(() => transitionEndCB?.());
+                const name = 'A, B, C, D';
+                const displayNameTexts = screen.queryAllByLabelText(name);
+                return waitFor(() => expect(displayNameTexts).toHaveLength(1));
+            }));
+
+    it('Should show only 5 names when there are 8 participants in the report header', () =>
+        signInAndGetApp('', participantAccountIDs8)
+            .then(() => {
+                // Verify the sidebar links are rendered
+                const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+                const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+                expect(sidebarLinks).toHaveLength(1);
+
+                // Verify there is only one option in the sidebar
+                const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+                const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+                expect(optionRows).toHaveLength(1);
+
+                const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+                const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+                expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D, E');
+
+                return navigateToSidebarOption(0);
+            })
+            .then(waitForBatchedUpdates)
+            .then(async () => {
+                await act(() => transitionEndCB?.());
+                const name = 'A, B, C, D, E';
+                const displayNameTexts = screen.queryAllByLabelText(name);
+                return waitFor(() => expect(displayNameTexts).toHaveLength(1));
+            }));
+
+    it('Should show exact name in header when report name is available with 4 participants', () =>
+        signInAndGetApp('Test chat', participantAccountIDs4)
+            .then(() => {
+                // Verify the sidebar links are rendered
+                const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+                const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+                expect(sidebarLinks).toHaveLength(1);
+
+                // Verify there is only one option in the sidebar
+                const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+                const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+                expect(optionRows).toHaveLength(1);
+
+                const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+                const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+                expect(displayNameText?.props?.children?.[0]).toBe('Test chat');
+
+                return navigateToSidebarOption(0);
+            })
+            .then(waitForBatchedUpdates)
+            .then(async () => {
+                await act(() => transitionEndCB?.());
+                const name = 'Test chat';
+                const displayNameTexts = screen.queryAllByLabelText(name);
+                return waitFor(() => expect(displayNameTexts).toHaveLength(1));
+            }));
+
+    it('Should show exact name in header when report name is available with 8 participants', () =>
+        signInAndGetApp("Let's talk", participantAccountIDs8)
+            .then(() => {
+                // Verify the sidebar links are rendered
+                const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+                const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+                expect(sidebarLinks).toHaveLength(1);
+
+                // Verify there is only one option in the sidebar
+                const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+                const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+                expect(optionRows).toHaveLength(1);
+
+                const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+                const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+                expect(displayNameText?.props?.children?.[0]).toBe("Let's talk");
+
+                return navigateToSidebarOption(0);
+            })
+            .then(waitForBatchedUpdates)
+            .then(async () => {
+                await act(() => transitionEndCB?.());
+                const name = "Let's talk";
+                const displayNameTexts = screen.queryAllByLabelText(name);
+                return waitFor(() => expect(displayNameTexts).toHaveLength(1));
+            }));
+
+    it('Should show last message preview in LHN', () =>
+        signInAndGetApp('A, B, C, D', participantAccountIDs4).then(() => {
+            // Verify the sidebar links are rendered
+            const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+            const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+            expect(sidebarLinks).toHaveLength(1);
+
+            // Verify there is only one option in the sidebar
+            const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+            const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+            expect(optionRows).toHaveLength(1);
+
+            const lastChatHintText = Localize.translateLocal('accessibilityHints.lastChatMessagePreview');
+            const lastChatText = screen.queryByLabelText(lastChatHintText);
+
+            return waitFor(() => expect(lastChatText?.props?.children).toBe('B: Test'));
+        }));
+
+    it('Should sort the names before displaying', () =>
+        signInAndGetApp('', [USER_E_ACCOUNT_ID, ...participantAccountIDs4]).then(() => {
+            // Verify the sidebar links are rendered
+            const sidebarLinksHintText = Localize.translateLocal('sidebarScreen.listOfChats');
+            const sidebarLinks = screen.queryAllByLabelText(sidebarLinksHintText);
+            expect(sidebarLinks).toHaveLength(1);
+
+            // Verify there is only one option in the sidebar
+            const optionRowsHintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
+            const optionRows = screen.queryAllByAccessibilityHint(optionRowsHintText);
+            expect(optionRows).toHaveLength(1);
+
+            const displayNameHintText = Localize.translateLocal('accessibilityHints.chatUserDisplayNames');
+            const displayNameText = screen.queryByLabelText(displayNameHintText);
+
+            return waitFor(() => expect(displayNameText?.props?.children?.[0]).toBe('A, B, C, D, E'));
+        }));
+});

tests/ui/UnreadIndicatorsTest.tsx

@@ -25,6 +25,7 @@ import type {ReportAction, ReportActions} from '@src/types/onyx';
 import type {NativeNavigationMock} from '../../__mocks__/@react-navigation/native';
 import PusherHelper from '../utils/PusherHelper';
 import * as TestHelper from '../utils/TestHelper';
+import {navigateToSidebarOption} from '../utils/TestHelper';
 import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';
 import waitForBatchedUpdatesWithAct from '../utils/waitForBatchedUpdatesWithAct';
 
@@ -82,16 +83,6 @@ function navigateToSidebar(): Promise<void> {
     return waitForBatchedUpdates();
 }
 
-async function navigateToSidebarOption(index: number): Promise<void> {
-    const hintText = Localize.translateLocal('accessibilityHints.navigatesToChat');
-    const optionRow = screen.queryAllByAccessibilityHint(hintText).at(index);
-    if (!optionRow) {
-        return;
-    }
-    fireEvent(optionRow, 'press');
-    await waitForBatchedUpdatesWithAct();
-}
-
 function areYouOnChatListScreen(): boolean {
     const hintText = Localize.translateLocal('sidebarScreen.listOfChats');
     const sidebarLinks = screen.queryAllByLabelText(hintText);