test: added unit tests for useTagsList

Author: aleksandernsilva

apps/meteor/client/components/Omnichannel/hooks/useTagsList.spec.ts

@@ -0,0 +1,57 @@
+import type { ILivechatTag, Serialized } from '@rocket.chat/core-typings';
+import { MockedAppRootBuilder } from '@rocket.chat/mock-providers/dist/MockedAppRootBuilder';
+import { act, renderHook, waitFor } from '@testing-library/react';
+
+import type { TagListItem } from './useTagsList';
+import { useTagsList } from './useTagsList';
+import { createFakeTag } from '../../../../tests/mocks/data';
+
+const formatTagItem = (tag: Serialized<ILivechatTag>): TagListItem => ({
+	_id: tag._id,
+	label: tag.name,
+	value: tag.name,
+});
+
+const mockGetTags = jest.fn();
+
+const appRoot = new MockedAppRootBuilder().withEndpoint('GET', '/v1/livechat/tags', mockGetTags);
+
+afterEach(() => {
+	jest.clearAllMocks();
+});
+
+it('should fetch tags', async () => {
+	const limit = 5;
+
+	const data = Array.from({ length: 10 }, () => createFakeTag());
+
+	mockGetTags.mockImplementation(({ offset, count }: { offset: number; count: number }) => {
+		const tags = data.slice(offset, offset + count);
+
+		return {
+			tags,
+			count,
+			offset,
+			total: data.length,
+		};
+	});
+
+	const { result } = renderHook(() => useTagsList({ filter: '', limit }), { wrapper: appRoot.build() });
+
+	expect(result.current.isFetching).toBe(true);
+	await waitFor(() => expect(result.current.isFetching).toBe(false));
+
+	expect(mockGetTags).toHaveBeenCalled();
+	expect(result.current.data).toEqual(data.slice(0, 5).map(formatTagItem));
+
+	await act(() => result.current.fetchNextPage());
+
+	expect(mockGetTags).toHaveBeenCalledTimes(2);
+	await waitFor(() => expect(result.current.data).toHaveLength(10));
+	expect(result.current.data).toEqual(data.map(formatTagItem));
+
+	await act(() => result.current.fetchNextPage());
+
+	// should not fetch again since total was reached
+	expect(mockGetTags).toHaveBeenCalledTimes(2);
+});

apps/meteor/client/components/Omnichannel/hooks/useTagsList.ts

@@ -9,7 +9,7 @@ type TagsListOptions = {
 	limit?: number;
 };
 
-type TagListItem = {
+export type TagListItem = {
 	_id: string;
 	label: string;
 	value: string;

apps/meteor/tests/mocks/data.ts

@@ -12,6 +12,7 @@ import type {
 	ILivechatContactChannel,
 	Serialized,
 	ILivechatAgent,
+	ILivechatTag,
 } from '@rocket.chat/core-typings';
 import { parse } from '@rocket.chat/message-parser';
 
@@ -363,3 +364,14 @@ export function createFakeAgent(overrides?: Partial<Serialized<ILivechatAgent>>)
 		...overrides,
 	};
 }
+
+export function createFakeTag(overrides?: Partial<Serialized<ILivechatTag>>): Serialized<ILivechatTag> {
+	return {
+		_id: faker.string.uuid(),
+		name: faker.commerce.department(),
+		description: 'description',
+		numDepartments: 0,
+		departments: [],
+		...overrides,
+	};
+}