snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/client/hooks/usePruneWarningMessage.spec.ts

@@ -0,0 +1,183 @@
+import type { IRoomWithRetentionPolicy } from '@rocket.chat/core-typings';
+import { renderHook, waitFor } from '@testing-library/react';
+
+import { usePruneWarningMessage } from './usePruneWarningMessage';
+import { createRenteionPolicySettingsMock as createMock } from '../../tests/mocks/client/mockRetentionPolicySettings';
+import { createFakeRoom } from '../../tests/mocks/data';
+
+jest.useFakeTimers();
+
+const getRetentionRoomProps = (props: Partial<IRoomWithRetentionPolicy['retention']> = {}) => {
+	return {
+		retention: {
+			enabled: true,
+			overrideGlobal: true,
+			maxAge: 30,
+			filesOnly: false,
+			excludePinned: false,
+			ignoreThreads: false,
+			...props,
+		},
+	};
+};
+// Warning: The dates are formated using date-fns/intlFormat, which itself uses the JS Intl API
+// The resulting formatted date can change depending on node version. These tests may break or the results
+// may be different when running on the browser.
+
+beforeEach(() => {
+	jest.setSystemTime(new Date(2024, 5, 1, 0, 0, 0));
+});
+
+describe('usePruneWarningMessage hook', () => {
+	describe('Cron timer and precision', () => {
+		it('Should update the message after the nextRunDate has passaed', async () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+				}),
+			});
+			expect(result.current).toEqual('1 minute June 1, 2024 at 12:30 AM');
+			await jest.advanceTimersByTimeAsync(31 * 60 * 1000);
+			await waitFor(() => expect(result.current).toEqual('1 minute June 1, 2024 at 1:00 AM'));
+		});
+
+		it('Should return the default warning with precision set to every_hour', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					precision: '1',
+				}),
+			});
+			expect(result.current).toEqual('1 minute June 1, 2024 at 1:00 AM');
+		});
+
+		it('Should return the default warning with precision set to every_six_hours', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					precision: '2',
+				}),
+			});
+			expect(result.current).toEqual('1 minute June 1, 2024 at 6:00 AM');
+		});
+
+		it('Should return the default warning with precision set to every_day', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					precision: '3',
+				}),
+			});
+			expect(result.current).toEqual('1 minute June 2, 2024 at 12:00 AM');
+		});
+
+		it('Should return the default warning with advanced precision', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					advancedPrecision: true,
+					advancedPrecisionCron: '0 0 1 */1 *',
+				}),
+			});
+			expect(result.current).toEqual('1 minute July 1, 2024 at 12:00 AM');
+		});
+	});
+
+	describe('No override', () => {
+		it('Should return the default warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+				}),
+			});
+			expect(result.current).toEqual('1 minute June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the unpinned messages warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					doNotPrunePinned: true,
+				}),
+			});
+			expect(result.current).toEqual('Unpinned 1 minute June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the files only warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					filesOnly: true,
+				}),
+			});
+			expect(result.current).toEqual('FilesOnly 1 minute June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the unpinned files only warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'c' });
+
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock({
+					appliesToChannels: true,
+					TTLChannels: 60000,
+					filesOnly: true,
+					doNotPrunePinned: true,
+				}),
+			});
+			expect(result.current).toEqual('UnpinnedFilesOnly 1 minute June 1, 2024 at 12:30 AM');
+		});
+	});
+
+	describe('Overriden', () => {
+		it('Should return the default warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'p', ...getRetentionRoomProps() });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock(),
+			});
+			expect(result.current).toEqual('30 days June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the unpinned messages warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'p', ...getRetentionRoomProps({ excludePinned: true }) });
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock(),
+			});
+			expect(result.current).toEqual('Unpinned 30 days June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the files only warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'p', ...getRetentionRoomProps({ filesOnly: true }) });
+
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock(),
+			});
+			expect(result.current).toEqual('FilesOnly 30 days June 1, 2024 at 12:30 AM');
+		});
+
+		it('Should return the unpinned files only warning', () => {
+			const fakeRoom = createFakeRoom({ t: 'p', ...getRetentionRoomProps({ excludePinned: true, filesOnly: true }) });
+
+			const { result } = renderHook(() => usePruneWarningMessage(fakeRoom), {
+				wrapper: createMock(),
+			});
+			expect(result.current).toEqual('UnpinnedFilesOnly 30 days June 1, 2024 at 12:30 AM');
+		});
+	});
+});