Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: refactor new room sound #34207

Merged
merged 4 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions apps/meteor/app/ui/client/lib/KonchatNotification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { router } from '../../../../client/providers/RouterProvider';
import { stripTags } from '../../../../lib/utils/stringUtils';
import { CustomSounds } from '../../../custom-sounds/client/lib/CustomSounds';
import { e2e } from '../../../e2e/client';
import { Subscriptions } from '../../../models/client';
import { Subscriptions, Users } from '../../../models/client';
import { getUserPreference } from '../../../utils/client';
import { getUserAvatarURL } from '../../../utils/client/getUserAvatarURL';
import { getUserNotificationsSoundVolume } from '../../../utils/client/getUserNotificationsSoundVolume';
Expand Down Expand Up @@ -207,27 +207,29 @@ class KonchatNotification {
}
}

public newRoom(rid: IRoom['_id']) {
public newRoom() {
Tracker.nonreactive(() => {
let newRoomSound = Session.get('newRoomSound') as IRoom['_id'][] | undefined;
if (newRoomSound) {
newRoomSound = [...newRoomSound, rid];
} else {
newRoomSound = [rid];
const uid = Meteor.userId();
if (!uid) {
return;
}
const user = Users.findOne(uid, {
fields: {
'settings.preferences.newRoomNotification': 1,
'settings.preferences.notificationsSoundVolume': 1,
},
});
const newRoomNotification = getUserPreference<string>(user, 'newRoomNotification');
const audioVolume = getUserNotificationsSoundVolume(user?._id);

return Session.set('newRoomSound', newRoomSound);
});
}

public removeRoomNotification(rid: IRoom['_id']) {
let newRoomSound = (Session.get('newRoomSound') as IRoom['_id'][] | undefined) ?? [];
newRoomSound = newRoomSound.filter((_rid) => _rid !== rid);
Tracker.nonreactive(() => Session.set('newRoomSound', newRoomSound));

const link = document.querySelector(`.link-room-${rid}`);
if (!newRoomNotification) {
return;
}

link?.classList.remove('new-room-highlight');
void CustomSounds.play(newRoomNotification, {
volume: Number((audioVolume / 100).toPrecision(2)),
});
});
}
}

Expand Down
2 changes: 1 addition & 1 deletion apps/meteor/client/hooks/useNotifyUser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const useNotifyUser = () => {
}

if ((!router.getRouteParameters().name || router.getRouteParameters().name !== sub.name) && !sub.ls && sub.alert === true) {
KonchatNotification.newRoom(sub.rid);
KonchatNotification.newRoom();
ggazzo marked this conversation as resolved.
Show resolved Hide resolved
}
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { useUserSoundPreferences } from './useUserSoundPreferences';
import { CustomSounds } from '../../app/custom-sounds/client/lib/CustomSounds';

const query = { t: 'l', ls: { $exists: false }, open: true };
export const useContinuousSoundNotification = () => {
export const useOmnichannelContinuousSoundNotification = <T>(queue: T[]) => {
const userSubscriptions = useUserSubscriptions(query);

const playNewRoomSoundContinuously = useSetting('Livechat_continuous_sound_notification_new_livechat_room');
Expand All @@ -16,6 +16,8 @@ export const useContinuousSoundNotification = () => {

const continuousCustomSoundId = newRoomNotification && `${newRoomNotification}-continuous`;

const hasUnreadRoom = userSubscriptions.length > 0 || queue.length > 0;

useEffect(() => {
let audio: ICustomSound;
if (playNewRoomSoundContinuously && continuousCustomSoundId) {
Expand All @@ -39,7 +41,7 @@ export const useContinuousSoundNotification = () => {
return;
}

if (userSubscriptions.length === 0) {
if (!hasUnreadRoom) {
CustomSounds.pause(continuousCustomSoundId);
return;
}
Expand All @@ -48,5 +50,5 @@ export const useContinuousSoundNotification = () => {
volume: notificationsSoundVolume,
loop: true,
});
}, [continuousCustomSoundId, playNewRoomSoundContinuously, userSubscriptions, notificationsSoundVolume]);
}, [continuousCustomSoundId, playNewRoomSoundContinuously, userSubscriptions, notificationsSoundVolume, hasUnreadRoom]);
};
3 changes: 0 additions & 3 deletions apps/meteor/client/lib/chats/flows/sendMessage.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type { IMessage } from '@rocket.chat/core-typings';

import { KonchatNotification } from '../../../../app/ui/client/lib/KonchatNotification';
import { sdk } from '../../../../app/utils/client/lib/SDKClient';
import { t } from '../../../../app/utils/lib/i18n';
import { onClientBeforeSendMessage } from '../../onClientBeforeSendMessage';
Expand All @@ -12,8 +11,6 @@ import { processSlashCommand } from './processSlashCommand';
import { processTooLongMessage } from './processTooLongMessage';

const process = async (chat: ChatAPI, message: IMessage, previewUrls?: string[], isSlashCommandAllowed?: boolean): Promise<void> => {
KonchatNotification.removeRoomNotification(message.rid);

if (await processSetReaction(chat, message)) {
return;
}
Expand Down
3 changes: 0 additions & 3 deletions apps/meteor/client/providers/CustomSoundProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import type { ReactNode } from 'react';
import React, { useEffect } from 'react';

import { CustomSounds } from '../../app/custom-sounds/client/lib/CustomSounds';
import { useContinuousSoundNotification } from '../hooks/useContinuousSoundNotification';

type CustomSoundProviderProps = {
children?: ReactNode;
Expand All @@ -18,8 +17,6 @@ const CustomSoundProvider = ({ children }: CustomSoundProviderProps) => {
void CustomSounds.fetchCustomSoundList();
}, [userId]);

useContinuousSoundNotification();

const streamAll = useStream('notify-all');

useEffect(() => {
Expand Down
26 changes: 18 additions & 8 deletions apps/meteor/client/providers/OmnichannelProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { ClientLogger } from '../../lib/ClientLogger';
import type { OmnichannelContextValue } from '../contexts/OmnichannelContext';
import { OmnichannelContext } from '../contexts/OmnichannelContext';
import { useHasLicenseModule } from '../hooks/useHasLicenseModule';
import { useOmnichannelContinuousSoundNotification } from '../hooks/useOmnichannelContinuousSoundNotification';
import { useReactiveValue } from '../hooks/useReactiveValue';
import { useShouldPreventAction } from '../hooks/useShouldPreventAction';

Expand Down Expand Up @@ -62,7 +63,6 @@ const OmnichannelProvider = ({ children }: OmnichannelProviderProps) => {
const getRoutingConfig = useMethod('livechat:getRoutingConfig');

const [routeConfig, setRouteConfig] = useSafely(useState<OmichannelRoutingConfig | undefined>(undefined));
const [queueNotification, setQueueNotification] = useState(new Set());

const accessible = hasAccess && omniChannelEnabled;
const iceServersSetting: any = useSetting('WebRTC_Servers');
Expand Down Expand Up @@ -150,13 +150,23 @@ const OmnichannelProvider = ({ children }: OmnichannelProviderProps) => {
}, [manuallySelected, omnichannelPoolMaxIncoming, omnichannelSortingMechanism]),
);

queue?.map(({ rid }) => {
if (queueNotification.has(rid)) {
return;
}
setQueueNotification((prev) => new Set([...prev, rid]));
return KonchatNotification.newRoom(rid);
});
useEffect(() => {
const observer = LivechatInquiry.find(
{ status: LivechatInquiryStatus.QUEUED },
{
sort: getOmniChatSortQuery(omnichannelSortingMechanism),
limit: omnichannelPoolMaxIncoming,
},
).observe({
added: (_inquiry) => {
KonchatNotification.newRoom();
},
});

return () => observer.stop();
}, [omnichannelPoolMaxIncoming, omnichannelSortingMechanism]);
Comment on lines +153 to +167
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this could be moved to the queueManager ? Might be worth it taking a look.


useOmnichannelContinuousSoundNotification(queue ?? []);

const contextValue = useMemo<OmnichannelContextValue>(() => {
if (!enabled) {
Expand Down
1 change: 0 additions & 1 deletion apps/meteor/client/startup/notifications/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
import './konchatNotifications';
import './notification';
43 changes: 0 additions & 43 deletions apps/meteor/client/startup/notifications/notification.ts

This file was deleted.

Loading