[NEW] Better Push and Email Notification logic

app/lib/server/functions/notifications/email.js

@@ -110,7 +110,7 @@ const getButtonUrl = (room, subscription, message) => {
 	});
 };
 
-export function sendEmail({ message, user, subscription, room, emailAddress, hasMentionToUser }) {
+export function getEmailData({ message, user, subscription, room, emailAddress, hasMentionToUser }) {
 	const username = settings.get('UI_Use_Real_Name') ? message.u.name || message.u.username : message.u.username;
 	let subjectKey = 'Offline_Mention_All_Email';
 
@@ -152,12 +152,20 @@ export function sendEmail({ message, user, subscription, room, emailAddress, has
 	}
 
 	metrics.notificationsSent.inc({ notification_type: 'email' });
-	return Mailer.send(email);
+	return email;
+}
+
+export function sendEmailFromData(data) {
+	metrics.notificationsSent.inc({ notification_type: 'email' });
+	return Mailer.send(data);
+}
+
+export function sendEmail({ message, user, subscription, room, emailAddress, hasMentionToUser }) {
+	return sendEmailFromData(getEmailData({ message, user, subscription, room, emailAddress, hasMentionToUser }));
 }
 
 export function shouldNotifyEmail({
 	disableAllMessageNotifications,
-	statusConnection,
 	emailNotifications,
 	isHighlighted,
 	hasMentionToUser,
@@ -170,11 +178,6 @@ export function shouldNotifyEmail({
 		return false;
 	}
 
-	// use connected (don't need to send him an email)
-	if (statusConnection === 'online') {
-		return false;
-	}
-
 	// user/room preference to nothing
 	if (emailNotifications === 'nothing') {
 		return false;

app/lib/server/functions/notifications/mobile.js

@@ -8,11 +8,6 @@ import { PushNotification } from '../../../../push-notifications/server';
 const CATEGORY_MESSAGE = 'MESSAGE';
 const CATEGORY_MESSAGE_NOREPLY = 'MESSAGE_NOREPLY';
 
-let alwaysNotifyMobileBoolean;
-settings.get('Notifications_Always_Notify_Mobile', (key, value) => {
-	alwaysNotifyMobileBoolean = value;
-});
-
 let SubscriptionRaw;
 Meteor.startup(() => {
 	SubscriptionRaw = Subscriptions.model.rawCollection();
@@ -46,13 +41,13 @@ function enableNotificationReplyButton(room, username) {
 	return !room.muted.includes(username);
 }
 
-export async function sendSinglePush({ room, message, userId, receiverUsername, senderUsername, senderName, notificationMessage }) {
+export async function getPushData({ room, message, userId, receiverUsername, senderUsername, senderName, notificationMessage }) {
 	let username = '';
 	if (settings.get('Push_show_username_room')) {
 		username = settings.get('UI_Use_Real_Name') === true ? senderName : senderUsername;
 	}
 
-	PushNotification.send({
+	return {
 		roomId: message.rid,
 		payload: {
 			host: Meteor.absoluteUrl(),
@@ -67,11 +62,13 @@ export async function sendSinglePush({ room, message, userId, receiverUsername,
 		username,
 		message: settings.get('Push_show_message') ? notificationMessage : ' ',
 		badge: await getBadgeCount(userId),
-		usersTo: {
-			userId,
-		},
+		userId,
 		category: enableNotificationReplyButton(room, receiverUsername) ? CATEGORY_MESSAGE : CATEGORY_MESSAGE_NOREPLY,
-	});
+	};
+}
+
+export async function sendSinglePush({ room, message, userId, receiverUsername, senderUsername, senderName, notificationMessage }) {
+	PushNotification.send(getPushData({ room, message, userId, receiverUsername, senderUsername, senderName, notificationMessage }));
 }
 
 export function shouldNotifyMobile({
@@ -81,7 +78,6 @@ export function shouldNotifyMobile({
 	isHighlighted,
 	hasMentionToUser,
 	hasReplyToThread,
-	statusConnection,
 	roomType,
 }) {
 	if (disableAllMessageNotifications && mobilePushNotifications == null && !isHighlighted && !hasMentionToUser && !hasReplyToThread) {
@@ -92,10 +88,6 @@ export function shouldNotifyMobile({
 		return false;
 	}
 
-	if (!alwaysNotifyMobileBoolean && statusConnection === 'online') {
-		return false;
-	}
-
 	if (!mobilePushNotifications) {
 		if (settings.get('Accounts_Default_User_Preferences_mobileNotifications') === 'all') {
 			return true;

app/lib/server/lib/sendNotificationsOnMessage.js

@@ -7,10 +7,11 @@ import { callbacks } from '../../../callbacks/server';
 import { Subscriptions, Users } from '../../../models/server';
 import { roomTypes } from '../../../utils';
 import { callJoinRoom, messageContainsHighlight, parseMessageTextPerUser, replaceMentionedUsernamesWithFullNames } from '../functions/notifications';
-import { sendEmail, shouldNotifyEmail } from '../functions/notifications/email';
-import { sendSinglePush, shouldNotifyMobile } from '../functions/notifications/mobile';
+import { getEmailData, shouldNotifyEmail } from '../functions/notifications/email';
+import { getPushData, shouldNotifyMobile } from '../functions/notifications/mobile';
 import { notifyDesktopUser, shouldNotifyDesktop } from '../functions/notifications/desktop';
 import { notifyAudioUser, shouldNotifyAudio } from '../functions/notifications/audio';
+import { Notification } from '../../../notification-queue/server/NotificationQueue';
 
 let TroubleshootDisableNotifications;
 
@@ -115,30 +116,33 @@ export const sendNotification = async ({
 		});
 	}
 
+	const queueItems = [];
+
 	if (shouldNotifyMobile({
 		disableAllMessageNotifications,
 		mobilePushNotifications,
 		hasMentionToAll,
 		isHighlighted,
 		hasMentionToUser,
 		hasReplyToThread,
-		statusConnection: receiver.statusConnection,
 		roomType,
 	})) {
-		sendSinglePush({
-			notificationMessage,
-			room,
-			message,
-			userId: subscription.u._id,
-			senderUsername: sender.username,
-			senderName: sender.name,
-			receiverUsername: receiver.username,
+		queueItems.push({
+			type: 'push',
+			data: await getPushData({
+				notificationMessage,
+				room,
+				message,
+				userId: subscription.u._id,
+				senderUsername: sender.username,
+				senderName: sender.name,
+				receiverUsername: receiver.username,
+			}),
 		});
 	}
 
 	if (receiver.emails && shouldNotifyEmail({
 		disableAllMessageNotifications,
-		statusConnection: receiver.statusConnection,
 		emailNotifications,
 		isHighlighted,
 		hasMentionToUser,
@@ -148,13 +152,25 @@ export const sendNotification = async ({
 	})) {
 		receiver.emails.some((email) => {
 			if (email.verified) {
-				sendEmail({ message, receiver, subscription, room, emailAddress: email.address, hasMentionToUser });
+				queueItems.push({
+					type: 'email',
+					data: getEmailData({ message, receiver, subscription, room, emailAddress: email.address, hasMentionToUser }),
+				});
 
 				return true;
 			}
 			return false;
 		});
 	}
+
+	if (queueItems.length) {
+		Notification.scheduleItem({
+			uid: subscription.u._id,
+			rid: room._id,
+			sid: subscription._id,
+			items: queueItems,
+		});
+	}
 };
 
 const project = {

app/lib/server/startup/settings.js

@@ -925,12 +925,6 @@ settings.addGroup('General', function() {
 			public: true,
 			i18nDescription: 'Notifications_Max_Room_Members_Description',
 		});
-
-		this.add('Notifications_Always_Notify_Mobile', false, {
-			type: 'boolean',
-			public: true,
-			i18nDescription: 'Notifications_Always_Notify_Mobile_Description',
-		});
 	});
 	this.section('REST API', function() {
 		return this.add('API_User_Limit', 500, {
@@ -1183,33 +1177,7 @@ settings.addGroup('Push', function() {
 		public: true,
 		alert: 'Push_Setting_Requires_Restart_Alert',
 	});
-	this.add('Push_debug', false, {
-		type: 'boolean',
-		public: true,
-		alert: 'Push_Setting_Requires_Restart_Alert',
-		enableQuery: {
-			_id: 'Push_enable',
-			value: true,
-		},
-	});
-	this.add('Push_send_interval', 2000, {
-		type: 'int',
-		public: true,
-		alert: 'Push_Setting_Requires_Restart_Alert',
-		enableQuery: {
-			_id: 'Push_enable',
-			value: true,
-		},
-	});
-	this.add('Push_send_batch_size', 100, {
-		type: 'int',
-		public: true,
-		alert: 'Push_Setting_Requires_Restart_Alert',
-		enableQuery: {
-			_id: 'Push_enable',
-			value: true,
-		},
-	});
+
 	this.add('Push_enable_gateway', true, {
 		type: 'boolean',
 		alert: 'Push_Setting_Requires_Restart_Alert',

app/models/server/models/NotificationQueue.js

@@ -0,0 +1,13 @@
+import { Base } from './_Base';
+
+export class NotificationQueue extends Base {
+	constructor() {
+		super('notification_queue');
+		this.tryEnsureIndex({ uid: 1 });
+		this.tryEnsureIndex({ ts: 1 }, { expireAfterSeconds: 2 * 60 * 60 });
+		this.tryEnsureIndex({ schedule: 1 }, { sparse: true });
+		this.tryEnsureIndex({ sending: 1 }, { sparse: true });
+	}
+}
+
+export default new NotificationQueue();

app/models/server/models/Sessions.tests.js

@@ -245,21 +245,23 @@ describe('Sessions Aggregates', () => {
 		after(() => { mongoUnit.stop(); });
 	}
 
-	before(function() {
-		return MongoClient.connect(process.env.MONGO_URL)
-			.then((client) => { db = client.db('test'); });
-	});
+	before(async () => {
+		const client = await MongoClient.connect(process.env.MONGO_URL);
+		db = client.db('test');
+
+		after(() => {
+			client.close();
+		});
+
+		await db.dropDatabase();
 
-	before(() => db.dropDatabase().then(() => {
 		const sessions = db.collection('sessions');
 		const sessions_dates = db.collection('sessions_dates');
 		return Promise.all([
 			sessions.insertMany(DATA.sessions),
 			sessions_dates.insertMany(DATA.sessions_dates),
 		]);
-	}));
-
-	after(() => { db.close(); });
+	});
 
 	it('should have sessions_dates data saved', () => {
 		const collection = db.collection('sessions_dates');

app/models/server/raw/BaseRaw.js

@@ -1,3 +1,5 @@
+import { ObjectId } from 'mongodb';
+
 export class BaseRaw {
 	constructor(col) {
 		this.col = col;
@@ -19,8 +21,11 @@ export class BaseRaw {
 		return this.col.find(...args);
 	}
 
-	insert(...args) {
-		return this.col.insert(...args);
+	insert(docs, options) {
+		if (!Array.isArray(docs) && !docs._id) {
+			docs._id = new ObjectId().toString();
+		}
+		return this.col.insert(docs, options);
 	}
 
 	update(...args) {

app/models/server/raw/NotificationQueue.js

@@ -0,0 +1,5 @@
+import { BaseRaw } from './BaseRaw';
+
+export class NotificationQueueRaw extends BaseRaw {
+
+}

app/models/server/raw/index.js

@@ -46,6 +46,8 @@ import LivechatAgentActivityModel from '../models/LivechatAgentActivity';
 import { LivechatAgentActivityRaw } from './LivechatAgentActivity';
 import StatisticsModel from '../models/Statistics';
 import { StatisticsRaw } from './Statistics';
+import NotificationQueueModel from '../models/NotificationQueue';
+import { NotificationQueueRaw } from './NotificationQueue';
 
 export const Permissions = new PermissionsRaw(PermissionsModel.model.rawCollection());
 export const Roles = new RolesRaw(RolesModel.model.rawCollection());
@@ -71,3 +73,4 @@ export const CustomSounds = new CustomSoundsRaw(CustomSoundsModel.model.rawColle
 export const CustomUserStatus = new CustomUserStatusRaw(CustomUserStatusModel.model.rawCollection());
 export const LivechatAgentActivity = new LivechatAgentActivityRaw(LivechatAgentActivityModel.model.rawCollection());
 export const Statistics = new StatisticsRaw(StatisticsModel.model.rawCollection());
+export const NotificationQueue = new NotificationQueueRaw(NotificationQueueModel.model.rawCollection());