feat: send push notifications for voice calls

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

@@ -1,4 +1,5 @@
 import { Push } from '@rocket.chat/core-services';
+import { pushTokenTypes } from '@rocket.chat/core-typings';
 import type { IPushToken, IPushTokenTypes } from '@rocket.chat/core-typings';
 import { Messages, PushToken, Users, Rooms, Settings } from '@rocket.chat/models';
 import {
@@ -38,7 +39,7 @@ const PushTokenPOSTSchema: JSONSchemaType<PushTokenPOST> = {
 		},
 		type: {
 			type: 'string',
-			enum: ['apn', 'gcm'],
+			enum: pushTokenTypes,
 		},
 		value: {
 			type: 'string',
@@ -148,6 +149,7 @@ const pushTokenEndpoints = API.v1
 								},
 								voipToken: {
 									type: 'string',
+									nullable: true,
 								},
 							},
 							additionalProperties: false,

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,15 @@ export const sendAPN = ({
 
 	const note = new apn.Notification();
 
-	note.expiry = Math.floor(Date.now() / 1000) + 3600; // Expires 1 hour from now.
+	// Expires 1 hour from now, unless configured otherwise.
+	const expirationSeconds = notification.apn?.expirationSeconds ?? 3600;
+
+	if (notification.useVoipToken) {
+		note.pushType = 'voip';
+	}
+
+	note.expiry = Math.floor(Date.now() / 1000) + expirationSeconds;
+
 	if (notification.badge !== undefined) {
 		note.badge = notification.badge;
 	}
@@ -50,10 +58,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 +76,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 +97,7 @@ export const sendAPN = ({
 					msg: 'Removing APN token',
 					token: userToken,
 				});
-				_removeToken({
-					apn: userToken,
-				});
+				_removeToken(userToken);
 			}
 		});
 	});

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

@@ -18,14 +18,15 @@ export type PushOptions = {
 };
 
 export type PendingPushNotification = {
-	from: string;
-	title: string;
-	text: string;
+	from?: string;
+	title?: string;
+	text?: string;
 	badge?: number;
 	sound?: string;
 	notId?: number;
 	apn?: {
 		category?: string;
+		expirationSeconds?: number;
 	};
 	gcm?: {
 		style?: string;
@@ -42,4 +43,5 @@ export type PendingPushNotification = {
 	priority?: number;
 
 	contentAvailable?: 1 | 0;
+	useVoipToken?: boolean;
 };

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

@@ -9,8 +9,8 @@ import type { NativeNotificationParameters } from './push';
 type FCMDataField = Record<string, any>;
 
 type FCMNotificationField = {
-	title: string;
-	body: string;
+	title?: string;
+	body?: string;
 	image?: string;
 };
 
@@ -140,13 +140,13 @@ function getFCMMessagesFromPushData(userTokens: string[], notification: PendingP
 
 	// then we will create the notification field
 	const notificationField: FCMNotificationField = {
-		title: notification.title,
-		body: notification.text,
+		...(notification.title && { title: notification.title }),
+		...(notification.text && { body: notification.text }),
 	};
 
 	// then we will create the message
 	const message: FCMMessage = {
-		notification: notificationField,
+		...(Object.keys(notificationField).length && { notification: notificationField }),
 		data,
 		android: {
 			priority: 'HIGH',
@@ -185,7 +185,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, {