refactor: Custom notification sound from streams (RocketChat#36774)

Author: yash-rajpal

apps/meteor/app/lib/server/functions/notifications/desktop.ts

@@ -22,13 +22,15 @@ export async function notifyDesktopUser({
 	room,
 	duration,
 	notificationMessage,
+	audioNotificationValue,
 }: {
 	userId: string;
 	user: AtLeast<IUser, '_id' | 'name' | 'username'>;
 	message: IMessage | Pick<IMessage, 'u'>;
 	room: IRoom;
 	duration?: number;
 	notificationMessage: string;
+	audioNotificationValue?: string;
 }): Promise<void> {
 	const { title, text, name } = await roomCoordinator
 		.getRoomDirectives(room.t)
@@ -57,6 +59,7 @@ export async function notifyDesktopUser({
 				}),
 			},
 			name,
+			audioNotificationValue,
 		},
 	};
 

apps/meteor/app/lib/server/lib/sendNotificationsOnMessage.ts

@@ -28,7 +28,15 @@ type SubscriptionAggregation = {
 	receiver: [Pick<IUser, 'active' | 'emails' | 'language' | 'status' | 'statusConnection' | 'username' | 'settings'> | null];
 } & Pick<
 	ISubscription,
-	'desktopNotifications' | 'emailNotifications' | 'mobilePushNotifications' | 'muteGroupMentions' | 'name' | 'rid' | 'userHighlights' | 'u'
+	| 'desktopNotifications'
+	| 'emailNotifications'
+	| 'mobilePushNotifications'
+	| 'muteGroupMentions'
+	| 'name'
+	| 'rid'
+	| 'userHighlights'
+	| 'u'
+	| 'audioNotificationValue'
 >;
 
 type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
@@ -134,6 +142,7 @@ export const sendNotification = async ({
 			user: sender,
 			message,
 			room,
+			audioNotificationValue: subscription.audioNotificationValue,
 		});
 	}
 
@@ -244,6 +253,7 @@ const project = {
 		'receiver.statusConnection': 1,
 		'receiver.username': 1,
 		'receiver.settings.preferences.enableMobileRinging': 1,
+		'audioNotificationValue': 1,
 	},
 } as const;
 

apps/meteor/client/hooks/notification/useNewMessageNotification.ts

@@ -2,8 +2,6 @@ import type { AtLeast, ISubscription } from '@rocket.chat/core-typings';
 import { useEffectEvent } from '@rocket.chat/fuselage-hooks';
 import { useCustomSound } from '@rocket.chat/ui-contexts';
 
-import { Subscriptions } from '../../stores';
-
 export const useNewMessageNotification = () => {
 	const { notificationSounds } = useCustomSound();
 
@@ -12,10 +10,8 @@ export const useNewMessageNotification = () => {
 			return;
 		}
 
-		const subscription = Subscriptions.state.find((record) => record.rid === sub.rid);
-
-		if (subscription?.audioNotificationValue) {
-			return notificationSounds.playNewMessageCustom(subscription.audioNotificationValue);
+		if (sub?.audioNotificationValue) {
+			return notificationSounds.playNewMessageCustom(sub.audioNotificationValue);
 		}
 
 		notificationSounds.playNewMessage();

apps/meteor/tests/e2e/notification-sounds.spec.ts

@@ -127,4 +127,30 @@ test.describe.serial('Notification Sounds', () => {
 			expect(audioCalls.played).toBe(true);
 		});
 	});
+
+	test.describe('none sound notification preferences', () => {
+		test.beforeEach(async ({ api }) => {
+			await api.post('/rooms.saveNotification', {
+				roomId: targetChannelId,
+				notifications: {
+					audioNotificationValue: 'none',
+				},
+			});
+		});
+
+		test('should not play any notification sound', async ({ page }) => {
+			await user1Page.goto(`/channel/${targetChannel}`);
+			const user1PoHomeChannel = new HomeChannel(user1Page);
+			await user1PoHomeChannel.content.waitForChannel();
+
+			await poHomeChannel.sidenav.sidebarHomeAction.click();
+
+			await user1PoHomeChannel.content.sendMessage(`Hello @${Users.admin.data.username} from User 1`);
+
+			await page.waitForTimeout(100); // wait for the sound to play
+
+			const audioCalls = await page.evaluate(() => window.__audioCalls);
+			expect(audioCalls).toBeUndefined();
+		});
+	});
 });

packages/core-typings/src/INotification.ts

@@ -1,6 +1,7 @@
 import type { ICalendarEvent } from './ICalendarEvent';
 import type { IMessage } from './IMessage';
 import type { IRoom } from './IRoom';
+import type { ISubscription } from './ISubscription';
 
 export interface INotificationItemPush {
 	type: 'push';
@@ -64,6 +65,7 @@ export interface INotificationDesktop {
 			msg: IMessage['msg'];
 			t?: IMessage['t'];
 		};
+		audioNotificationValue: ISubscription['audioNotificationValue'];
 	};
 }