fix: test button not playing default sound in notification preferences

.changeset/major-coats-smash.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': patch
+---
+
+Fixes test button not playing default sound in Notifications Preferences

apps/meteor/client/providers/CustomSoundProvider/CustomSoundProvider.spec.tsx

@@ -0,0 +1,116 @@
+import { mockAppRoot } from '@rocket.chat/mock-providers';
+import { useCustomSound } from '@rocket.chat/ui-contexts';
+import { renderHook, act } from '@testing-library/react';
+import React from 'react';
+
+import CustomSoundProvider from './CustomSoundProvider';
+
+jest.mock('./lib', () => ({
+	defaultSounds: [
+		{ _id: 'chime', name: 'Sound_Chime', extension: 'mp3', src: 'sounds/chime.mp3' },
+		{ _id: 'door', name: 'Sound_Door', extension: 'mp3', src: 'sounds/door.mp3' },
+		{ _id: 'ringtone', name: 'Sound_Ringtone', extension: 'mp3', src: 'sounds/ringtone.mp3' },
+	],
+	getCustomSoundURL: (sound: { _id: string; extension: string }) => `sounds/${sound._id}.${sound.extension}`,
+}));
+
+jest.mock('../../../app/utils/client/lib/SDKClient', () => ({
+	sdk: {
+		call: jest.fn().mockResolvedValue([]),
+	},
+}));
+
+jest.mock('@rocket.chat/ui-contexts', () => ({
+	...jest.requireActual('@rocket.chat/ui-contexts'),
+	useStream: () => () => () => undefined,
+}));
+
+jest.mock('../../hooks/useUserSoundPreferences', () => ({
+	useUserSoundPreferences: () => ({
+		notificationsSoundVolume: 100,
+		voipRingerVolume: 100,
+	}),
+}));
+
+const mockPlay = jest.fn().mockResolvedValue(undefined);
+const mockLoad = jest.fn();
+const audioInstances: { src: string }[] = [];
+
+class MockAudio {
+	src: string;
+
+	id = '';
+
+	volume = 1;
+
+	loop = false;
+
+	constructor(src: string) {
+		this.src = src;
+		audioInstances.push(this);
+	}
+
+	play = mockPlay;
+
+	load = mockLoad;
+}
+
+const buildWrapper = (appRootBuilder: ReturnType<typeof mockAppRoot>) => {
+	return appRootBuilder.wrap((children) => React.createElement(CustomSoundProvider, null, children)).build();
+};
+
+beforeAll(() => {
+	Object.defineProperty(global, 'Audio', { value: MockAudio, writable: true });
+});
+
+afterEach(() => {
+	jest.clearAllMocks();
+	audioInstances.length = 0;
+});
+
+describe('CustomSoundProvider - play()', () => {
+	it('should play the default newMessageNotification sound (ringtone) when soundId is "default"', async () => {
+		const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => undefined);
+		const wrapper = buildWrapper(mockAppRoot().withUserPreference('newMessageNotification', 'ringtone'));
+
+		const { result } = renderHook(() => useCustomSound(), { wrapper });
+
+		await act(async () => {
+			result.current.play('default');
+		});
+
+		expect(mockPlay).toHaveBeenCalledTimes(1);
+		expect(audioInstances[0].src).toContain('ringtone');
+		expect(consoleSpy).not.toHaveBeenCalled();
+		consoleSpy.mockRestore();
+	});
+
+	it('should fall back to "chime" when newMessageNotification preference is not set and soundId is "default"', async () => {
+		const wrapper = buildWrapper(mockAppRoot());
+
+		const { result } = renderHook(() => useCustomSound(), { wrapper });
+
+		await act(async () => {
+			result.current.play('default');
+		});
+
+		expect(mockPlay).toHaveBeenCalledTimes(1);
+		expect(audioInstances[0].src).toContain('chime');
+	});
+
+	it('should play the sound directly when a valid soundId is provided', async () => {
+		const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => undefined);
+		const wrapper = buildWrapper(mockAppRoot().withUserPreference('newMessageNotification', 'chime'));
+
+		const { result } = renderHook(() => useCustomSound(), { wrapper });
+
+		await act(async () => {
+			result.current.play('door');
+		});
+
+		expect(mockPlay).toHaveBeenCalledTimes(1);
+		expect(audioInstances[0].src).toContain('door');
+		expect(consoleSpy).not.toHaveBeenCalled();
+		consoleSpy.mockRestore();
+	});
+});

apps/meteor/client/providers/CustomSoundProvider/CustomSoundProvider.tsx

@@ -35,11 +35,12 @@ const CustomSoundProvider = ({ children }: CustomSoundProviderProps) => {
 	});
 
 	const play = useEffectEvent((soundId: ICustomSound['_id'], { volume = 1, loop = false } = {}) => {
-		stop(soundId);
+		const resolvedSoundId = soundId === 'default' ? newMessageNotification : soundId;
+		stop(resolvedSoundId);
 
-		const item = list?.find(({ _id }) => _id === soundId);
+		const item = list?.find(({ _id }) => _id === resolvedSoundId);
 		if (!item?.src) {
-			console.error('Unable to play sound', soundId);
+			console.error('Unable to play sound', resolvedSoundId);
 			return;
 		}
 
@@ -52,7 +53,7 @@ const CustomSoundProvider = ({ children }: CustomSoundProviderProps) => {
 		audioRefs.current = [...audioRefs.current, audio];
 
 		return () => {
-			stop(soundId);
+			stop(resolvedSoundId);
 		};
 	});