Files
upstream-rocketchat/apps/meteor/server/meteor-methods/users/saveNotificationSettings.ts
upstream-mirror 30810eecd7
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Code scanning - action / CodeQL-Build (push) Failing after 2s
snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)
2026-09-16 01:21:02 +05:00

173 lines
6.1 KiB
TypeScript

import type { ISubscription } from '@rocket.chat/core-typings';
import type { ServerMethods } from '@rocket.chat/ddp-client';
import { Subscriptions } from '@rocket.chat/models';
import { check } from 'meteor/check';
import { Meteor } from 'meteor/meteor';
import { methodDeprecationLogger } from '../../lib/deprecationWarningLogger';
import { notifyOnSubscriptionChangedById } from '../../lib/notifyListener';
import { getUserNotificationPreference } from '../../lib/utils/getUserNotificationPreference';
const saveAudioNotificationValue = (subId: ISubscription['_id'], value: string) =>
value === 'default' ? Subscriptions.clearAudioNotificationValueById(subId) : Subscriptions.updateAudioNotificationValueById(subId, value);
export type NotificationFieldType =
| 'desktopNotifications'
| 'mobilePushNotifications'
| 'emailNotifications'
| 'unreadAlert'
| 'disableNotifications'
| 'hideUnreadStatus'
| 'hideMentionStatus'
| 'muteGroupMentions'
| 'audioNotificationValue';
declare module '@rocket.chat/ddp-client' {
// eslint-disable-next-line @typescript-eslint/naming-convention
interface ServerMethods {
saveNotificationSettings(roomId: string, field: NotificationFieldType, value: string): boolean;
saveAudioNotificationValue(subId: string, value: string): boolean;
}
}
export const saveNotificationSettingsMethod = async (
userId: string,
roomId: string,
field: NotificationFieldType,
value: string,
): Promise<boolean> => {
const getNotificationPrefValue = async (field: string, value: unknown) => {
if (value === 'default') {
if (!userId) {
throw new Meteor.Error('error-invalid-user', 'Invalid user', {
method: 'saveNotificationSettings',
});
}
const userPref = await getUserNotificationPreference(userId, field);
return userPref?.origin === 'server' ? null : userPref;
}
return { value, origin: 'subscription' };
};
const notifications = {
desktopNotifications: {
updateMethod: async (subscription: ISubscription, value: unknown) =>
Subscriptions.updateNotificationsPrefById(
subscription._id,
await getNotificationPrefValue('desktop', value),
'desktopNotifications',
'desktopPrefOrigin',
),
},
mobilePushNotifications: {
updateMethod: async (subscription: ISubscription, value: unknown) =>
Subscriptions.updateNotificationsPrefById(
subscription._id,
await getNotificationPrefValue('mobile', value),
'mobilePushNotifications',
'mobilePrefOrigin',
),
},
emailNotifications: {
updateMethod: async (subscription: ISubscription, value: unknown) =>
Subscriptions.updateNotificationsPrefById(
subscription._id,
await getNotificationPrefValue('email', value),
'emailNotifications',
'emailPrefOrigin',
),
},
unreadAlert: {
// @ts-expect-error - Check types of model. The way the method is defined makes difficult to type it, check proper types for `value`
updateMethod: (subscription: ISubscription, value: string) => Subscriptions.updateUnreadAlertById(subscription._id, value),
},
disableNotifications: {
updateMethod: (subscription: ISubscription, value: unknown) =>
Subscriptions.updateDisableNotificationsById(subscription._id, value === '1'),
},
hideUnreadStatus: {
updateMethod: (subscription: ISubscription, value: string) =>
Subscriptions.updateHideUnreadStatusById(subscription._id, value === '1'),
},
hideMentionStatus: {
updateMethod: (subscription: ISubscription, value: unknown) =>
Subscriptions.updateHideMentionStatusById(subscription._id, value === '1'),
},
muteGroupMentions: {
updateMethod: (subscription: ISubscription, value: unknown) => Subscriptions.updateMuteGroupMentions(subscription._id, value === '1'),
},
audioNotificationValue: {
updateMethod: (subscription: ISubscription, value: string) => saveAudioNotificationValue(subscription._id, value),
},
};
const isInvalidNotification = !Object.keys(notifications).includes(field);
const basicValuesForNotifications = ['all', 'mentions', 'nothing', 'default'];
const fieldsMustHaveBasicValues = ['emailNotifications', 'mobilePushNotifications', 'desktopNotifications'];
if (isInvalidNotification) {
throw new Meteor.Error('error-invalid-settings', 'Invalid settings field', {
method: 'saveNotificationSettings',
});
}
if (fieldsMustHaveBasicValues.includes(field) && !basicValuesForNotifications.includes(value)) {
throw new Meteor.Error('error-invalid-settings', 'Invalid settings value', {
method: 'saveNotificationSettings',
});
}
const subscription = await Subscriptions.findOneByRoomIdAndUserId(roomId, userId);
if (!subscription) {
throw new Meteor.Error('error-invalid-subscription', 'Invalid subscription', {
method: 'saveNotificationSettings',
});
}
const updateResponse = await notifications[field].updateMethod(subscription, value);
if (updateResponse.modifiedCount) {
void notifyOnSubscriptionChangedById(subscription._id);
}
return true;
};
Meteor.methods<ServerMethods>({
async saveNotificationSettings(roomId, field, value) {
methodDeprecationLogger.method('saveNotificationSettings', '9.0.0', '/v1/rooms.saveNotification');
const userId = Meteor.userId();
if (!userId) {
throw new Meteor.Error('error-invalid-user', 'Invalid user', {
method: 'saveNotificationSettings',
});
}
check(roomId, String);
check(field, String);
check(value, String);
return saveNotificationSettingsMethod(userId, roomId, field, value);
},
async saveAudioNotificationValue(rid, value) {
const userId = Meteor.userId();
if (!userId) {
throw new Meteor.Error('error-invalid-user', 'Invalid user', {
method: 'saveAudioNotificationValue',
});
}
const subscription = await Subscriptions.findOneByRoomIdAndUserId(rid, userId);
if (!subscription) {
throw new Meteor.Error('error-invalid-subscription', 'Invalid subscription', {
method: 'saveAudioNotificationValue',
});
}
const saveAudioNotificationResponse = await saveAudioNotificationValue(subscription._id, value);
if (saveAudioNotificationResponse.modifiedCount) {
void notifyOnSubscriptionChangedById(subscription._id);
}
return true;
},
});