feat: send push notifications for voice calls

Author: pierre-lehnen-rc

apps/meteor/app/push/server/apn.ts

@@ -1,5 +1,5 @@
 import apn from '@parse/node-apn';
-import type { IPushToken, RequiredField } from '@rocket.chat/core-typings';
+import type { RequiredField } from '@rocket.chat/core-typings';
 import EJSON from 'ejson';
 
 import type { PushOptions, PendingPushNotification } from './definition';
@@ -24,7 +24,7 @@ export const sendAPN = ({
 }: {
 	userToken: string;
 	notification: PendingPushNotification & { topic: string };
-	_removeToken: (token: IPushToken['token']) => void;
+	_removeToken: (token: string) => void;
 }) => {
 	if (!apnConnection) {
 		throw new Error('Apn Connection not initialized.');
@@ -34,7 +34,13 @@ export const sendAPN = ({
 
 	const note = new apn.Notification();
 
-	note.expiry = Math.floor(Date.now() / 1000) + 3600; // Expires 1 hour from now.
+	if (notification.voip) {
+		note.expiry = Math.floor(Date.now() / 1000) + 60; // Expires in 60 seconds
+		note.pushType = 'voip';
+	} else {
+		note.expiry = Math.floor(Date.now() / 1000) + 3600; // Expires 1 hour from now.
+	}
+
 	if (notification.badge !== undefined) {
 		note.badge = notification.badge;
 	}
@@ -50,10 +56,16 @@ export const sendAPN = ({
 	// adds category support for iOS8 custom actions as described here:
 	// https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/
 	// RemoteNotificationsPG/Chapters/IPhoneOSClientImp.html#//apple_ref/doc/uid/TP40008194-CH103-SW36
-	note.category = notification.apn?.category;
+	if (notification.apn?.category) {
+		note.category = notification.apn.category;
+	}
 
-	note.body = notification.text;
-	note.title = notification.title;
+	if (notification.text) {
+		note.body = notification.text;
+	}
+	if (notification.title) {
+		note.title = notification.title;
+	}
 
 	if (notification.notId != null) {
 		note.threadId = String(notification.notId);
@@ -62,7 +74,9 @@ export const sendAPN = ({
 	// Allow the user to set payload data
 	note.payload = notification.payload ? { ejson: EJSON.stringify(notification.payload) } : {};
 
-	note.payload.messageFrom = notification.from;
+	if (notification.from) {
+		note.payload.messageFrom = notification.from;
+	}
 	note.priority = priority;
 
 	note.topic = notification.topic;
@@ -81,9 +95,7 @@ export const sendAPN = ({
 					msg: 'Removing APN token',
 					token: userToken,
 				});
-				_removeToken({
-					apn: userToken,
-				});
+				_removeToken(userToken);
 			}
 		});
 	});

apps/meteor/app/push/server/definition.ts

@@ -1,3 +1,5 @@
+import { type RequiredField } from '@rocket.chat/core-typings';
+
 export type PushOptions = {
 	sendTimeout?: number;
 	production?: boolean;
@@ -17,10 +19,10 @@ export type PushOptions = {
 	getAuthorization?: () => Promise<string>;
 };
 
-export type PendingPushNotification = {
-	from: string;
-	title: string;
-	text: string;
+export type BasePendingPushNotification = {
+	from?: string;
+	title?: string;
+	text?: string;
 	badge?: number;
 	sound?: string;
 	notId?: number;
@@ -42,4 +44,11 @@ export type PendingPushNotification = {
 	priority?: number;
 
 	contentAvailable?: 1 | 0;
+	voip?: boolean;
 };
+
+export type PendingMessagePushNotification = RequiredField<BasePendingPushNotification, 'from' | 'title' | 'text'> & { voip?: false };
+
+export type PendingVoipPushNotification = BasePendingPushNotification & { voip: true };
+
+export type PendingPushNotification = PendingMessagePushNotification | PendingVoipPushNotification;

apps/meteor/app/push/server/fcm.ts

@@ -138,15 +138,9 @@ function getFCMMessagesFromPushData(userTokens: string[], notification: PendingP
 		data['content-available'] = notification.contentAvailable.toString();
 	}
 
-	// then we will create the notification field
-	const notificationField: FCMNotificationField = {
-		title: notification.title,
-		body: notification.text,
-	};
-
 	// then we will create the message
 	const message: FCMMessage = {
-		notification: notificationField,
+		...(!notification.voip && { notification: { title: notification.title, body: notification.text } }),
 		data,
 		android: {
 			priority: 'HIGH',
@@ -185,7 +179,7 @@ export const sendFCM = function ({ userTokens, notification, _removeToken, optio
 
 		const removeToken = () => {
 			const { token } = fcmRequest.message;
-			token && _removeToken({ gcm: token });
+			token && _removeToken(token);
 		};
 
 		const response = fetchWithRetry(url, removeToken, {

apps/meteor/app/push/server/push.ts

@@ -78,9 +78,9 @@ export const isFCMCredentials = ajv.compile<FCMCredentials>(FCMCredentialsValida
 // This type must match the type defined in the push gateway
 type GatewayNotification = {
 	uniqueId: string;
-	from: string;
-	title: string;
-	text: string;
+	from?: string;
+	title?: string;
+	text?: string;
 	badge?: number;
 	sound?: string;
 	notId?: number;
@@ -123,8 +123,7 @@ type GatewayNotification = {
 export type NativeNotificationParameters = {
 	userTokens: string | string[];
 	notification: PendingPushNotification;
-	_replaceToken: (currentToken: IPushToken['token'], newToken: IPushToken['token']) => void;
-	_removeToken: (token: IPushToken['token']) => void;
+	_removeToken: (token: string) => void;
 	options: RequiredField<PushOptions, 'gcm'>;
 };
 
@@ -167,12 +166,10 @@ class PushClass {
 		}
 	}
 
-	private replaceToken(currentToken: IPushToken['token'], newToken: IPushToken['token']): void {
-		void PushToken.updateMany({ token: currentToken }, { $set: { token: newToken } });
-	}
-
-	private removeToken(token: IPushToken['token']): void {
-		void PushToken.deleteOne({ token });
+	private removeToken(token: string): void {
+		void PushToken.removeAllByTokenString(token).catch((err) => {
+			logger.error({ msg: 'Failed to remove push token', err });
+		});
 	}
 
 	private shouldUseGateway(): boolean {
@@ -188,10 +185,13 @@ class PushClass {
 		logger.debug({ msg: 'send to token', token: app.token });
 
 		if ('apn' in app.token && app.token.apn) {
+			const userToken = notification.voip ? app.voipToken : app.token.apn;
+			const topic = notification.voip ? `${app.appName}.voip` : app.appName;
+
 			countApn.push(app._id);
 			// Send to APN
-			if (this.options.apn) {
-				sendAPN({ userToken: app.token.apn, notification: { topic: app.appName, ...notification }, _removeToken: this.removeToken });
+			if (this.options.apn && userToken) {
+				sendAPN({ userToken, notification: { topic, ...notification }, _removeToken: this.removeToken });
 			}
 		} else if ('gcm' in app.token && app.token.gcm) {
 			countGcm.push(app._id);
@@ -210,7 +210,6 @@ class PushClass {
 			sendFCM({
 				userTokens: app.token.gcm,
 				notification,
-				_replaceToken: this.replaceToken,
 				_removeToken: this.removeToken,
 				options: sendGCMOptions as RequiredField<PushOptions, 'gcm'>,
 			});
@@ -275,16 +274,7 @@ class PushClass {
 
 		if (result.status === 406) {
 			logger.info({ msg: 'removing push token', token });
-			await PushToken.deleteMany({
-				$or: [
-					{
-						'token.apn': token,
-					},
-					{
-						'token.gcm': token,
-					},
-				],
-			});
+			this.removeToken(token);
 			return;
 		}
 
@@ -340,8 +330,13 @@ class PushClass {
 			logger.debug({ msg: 'send to token', token: app.token });
 
 			if ('apn' in app.token && app.token.apn) {
-				countApn.push(app._id);
-				return this.sendGatewayPush(gateway, 'apn', app.token.apn, { topic: app.appName, ...gatewayNotification });
+				const token = notification.voip ? app.voipToken : app.token.apn;
+				const topic = notification.voip ? `${app.appName}.voip` : app.appName;
+
+				if (token) {
+					countApn.push(app._id);
+					return this.sendGatewayPush(gateway, 'apn', token, { topic, ...gatewayNotification });
+				}
 			}
 
 			if ('gcm' in app.token && app.token.gcm) {
@@ -373,12 +368,7 @@ class PushClass {
 			userId: notification.userId,
 		});
 
-		const query = {
-			userId: notification.userId,
-			$or: [{ 'token.apn': { $exists: true } }, { 'token.gcm': { $exists: true } }],
-		};
-
-		const appTokens = PushToken.find(query);
+		const appTokens = PushToken.findAllTokensByUserId(notification.userId);
 
 		for await (const app of appTokens) {
 			logger.debug({ msg: 'send to token', token: app.token });
@@ -427,9 +417,9 @@ class PushClass {
 	private _validateDocument(notification: PendingPushNotification): void {
 		// Check the general notification
 		check(notification, {
-			from: String,
-			title: String,
-			text: String,
+			from: Match.Optional(String),
+			title: Match.Optional(String),
+			text: Match.Optional(String),
 			sent: Match.Optional(Boolean),
 			sending: Match.Optional(Match.Integer),
 			badge: Match.Optional(Match.Integer),
@@ -448,11 +438,24 @@ class PushClass {
 			createdAt: Date,
 			createdBy: Match.OneOf(String, null),
 			priority: Match.Optional(Match.Integer),
+			voip: Match.Optional(Boolean),
 		});
 
 		if (!notification.userId) {
 			throw new Error('No userId found');
 		}
+
+		if (!notification.voip) {
+			const { from, title, text } = notification;
+			check(
+				{ from, title, text },
+				{
+					from: String,
+					title: String,
+					text: String,
+				},
+			);
+		}
 	}
 
 	private hasApnOptions(options: IPushNotificationConfig): options is RequiredField<IPushNotificationConfig, 'apn'> {
@@ -463,17 +466,31 @@ class PushClass {
 		return Match.test(options.gcm, Object);
 	}
 
-	public async send(options: IPushNotificationConfig) {
-		const notification: PendingPushNotification = {
+	private getPendingNotification(options: IPushNotificationConfig): PendingPushNotification {
+		const required = {
 			createdAt: new Date(),
 			// createdBy is no longer used, but the gateway still expects it
 			createdBy: '<SERVER>',
 			sent: false,
 			sending: 0,
+			...pick(options, 'userId', 'payload', 'notId', 'priority'),
+		} as const;
+
+		if (options.voip) {
+			return {
+				...required,
+				voip: true,
+			};
+		}
+
+		return {
+			voip: false,
+			...required,
+
 			title: truncateString(options.title, PUSH_TITLE_LIMIT),
 			text: truncateString(options.text, PUSH_MESSAGE_BODY_LIMIT),
 
-			...pick(options, 'from', 'userId', 'payload', 'badge', 'sound', 'notId', 'priority'),
+			...pick(options, 'from', 'badge', 'sound'),
 
 			...(this.hasApnOptions(options)
 				? {
@@ -490,6 +507,10 @@ class PushClass {
 					}
 				: {}),
 		};
+	}
+
+	public async send(options: IPushNotificationConfig) {
+		const notification = this.getPendingNotification(options);
 
 		// Validate the notification
 		this._validateDocument(notification);