qa: mobile voip test branch

.changeset/eighty-experts-sort.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/ui-voip': patch
+'@rocket.chat/meteor': patch
+---
+
+Fixes empty notifications sent when a voice call ends

.changeset/fair-lions-smell.md

@@ -0,0 +1,10 @@
+---
+'@rocket.chat/media-calls': minor
+'@rocket.chat/core-services': minor
+'@rocket.chat/model-typings': minor
+'@rocket.chat/models': minor
+'@rocket.chat/meteor': minor
+'@rocket.chat/media-signaling': minor
+---
+
+Adds a new REST endpoint to accept or reject media calls without an active media session

apps/meteor/app/api/server/index.ts

@@ -21,6 +21,7 @@ import './v1/integrations';
 import './v1/invites';
 import './v1/import';
 import './v1/ldap';
+import './v1/media-calls';
 import './v1/misc';
 import './v1/permissions';
 import './v1/presence';

apps/meteor/app/api/server/v1/media-calls.ts

@@ -0,0 +1,98 @@
+import { MediaCall } from '@rocket.chat/core-services';
+import type { IMediaCall } from '@rocket.chat/core-typings';
+import type { CallAnswer, CallFeature } from '@rocket.chat/media-signaling';
+import { callFeatureList, callAnswerList } from '@rocket.chat/media-signaling';
+import {
+	ajv,
+	validateNotFoundErrorResponse,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
+	validateForbiddenErrorResponse,
+} from '@rocket.chat/rest-typings';
+import type { JSONSchemaType } from 'ajv';
+
+import type { ExtractRoutesFromAPI } from '../ApiClass';
+import { API } from '../api';
+
+type MediaCallsAnswer = {
+	callId: string;
+	contractId: string;
+
+	answer: CallAnswer;
+
+	supportedFeatures?: CallFeature[];
+};
+
+const MediaCallsAnswerSchema: JSONSchemaType<MediaCallsAnswer> = {
+	type: 'object',
+	properties: {
+		callId: {
+			type: 'string',
+		},
+		contractId: {
+			type: 'string',
+		},
+		answer: {
+			type: 'string',
+			enum: callAnswerList,
+		},
+		supportedFeatures: {
+			type: 'array',
+			items: {
+				type: 'string',
+				enum: callFeatureList,
+			},
+			nullable: true,
+		},
+	},
+	required: ['callId', 'contractId', 'answer'],
+	additionalProperties: false,
+};
+
+export const isMediaCallsAnswerProps = ajv.compile<MediaCallsAnswer>(MediaCallsAnswerSchema);
+
+const mediaCallsAnswerEndpoints = API.v1.post(
+	'media-calls.answer',
+	{
+		response: {
+			200: ajv.compile<{
+				call: IMediaCall;
+			}>({
+				additionalProperties: false,
+				type: 'object',
+				properties: {
+					call: {
+						type: 'object',
+						$ref: '#/components/schemas/IMediaCall',
+						description: 'The updated call information.',
+					},
+					success: {
+						type: 'boolean',
+						description: 'Indicates if the request was successful.',
+					},
+				},
+				required: ['call', 'success'],
+			}),
+			400: validateBadRequestErrorResponse,
+			401: validateUnauthorizedErrorResponse,
+			403: validateForbiddenErrorResponse,
+			404: validateNotFoundErrorResponse,
+		},
+		body: isMediaCallsAnswerProps,
+		authRequired: true,
+	},
+	async function action() {
+		const call = await MediaCall.answerCall(this.userId, this.bodyParams);
+
+		return API.v1.success({
+			call,
+		});
+	},
+);
+
+type MediaCallsAnswerEndpoints = ExtractRoutesFromAPI<typeof mediaCallsAnswerEndpoints>;
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
+	interface Endpoints extends MediaCallsAnswerEndpoints {}
+}

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/lib/server/functions/sendMessage.ts

@@ -13,9 +13,10 @@ import { afterSaveMessage } from '../lib/afterSaveMessage';
 import { notifyOnRoomChangedById } from '../lib/notifyListener';
 import { validateCustomMessageFields } from '../lib/validateCustomMessageFields';
 
-type SendMessageOptions = {
+export type SendMessageOptions = {
 	upsert?: boolean;
 	previewUrls?: string[];
+	skipNotifications?: boolean;
 };
 
 // TODO: most of the types here are wrong, but I don't want to change them now
@@ -289,7 +290,7 @@ export const sendMessage = async function (user: any, message: any, room: any, o
 		void Apps.self?.triggerEvent(messageEvent, message);
 	}
 
-	await afterSaveMessage(message, room, user);
+	await afterSaveMessage(message, room, user, { options });
 
 	void notifyOnRoomChangedById(message.rid);
 

apps/meteor/app/lib/server/lib/afterSaveMessage.ts

@@ -4,10 +4,28 @@ import type { Updater } from '@rocket.chat/models';
 import { Rooms } from '@rocket.chat/models';
 
 import { callbacks } from '../../../../server/lib/callbacks';
-
-export async function afterSaveMessage(message: IMessage, room: IRoom, user: IUser, roomUpdater?: Updater<IRoom>): Promise<IMessage> {
+import type { SendMessageOptions } from '../functions/sendMessage';
+
+export async function afterSaveMessage(
+	message: IMessage,
+	room: IRoom,
+	user: IUser,
+	{
+		roomUpdater,
+		options,
+	}: {
+		roomUpdater?: Updater<IRoom>;
+		options?: SendMessageOptions;
+	} = {},
+): Promise<IMessage> {
 	const updater = roomUpdater ?? Rooms.getUpdater();
-	const data: IMessage = (await callbacks.run('afterSaveMessage', message, { room, user, roomUpdater: updater })) as unknown as IMessage;
+
+	const data: IMessage = (await callbacks.run('afterSaveMessage', message, {
+		room,
+		user,
+		roomUpdater: updater,
+		options,
+	})) as unknown as IMessage;
 
 	if (!roomUpdater && updater.hasChanges()) {
 		await Rooms.updateFromUpdater({ _id: room._id }, updater);
@@ -19,8 +37,21 @@ export async function afterSaveMessage(message: IMessage, room: IRoom, user: IUs
 	return data;
 }
 
-export function afterSaveMessageAsync(message: IMessage, room: IRoom, user: IUser, roomUpdater: Updater<IRoom> = Rooms.getUpdater()): void {
-	callbacks.runAsync('afterSaveMessage', message, { room, user, roomUpdater });
+export function afterSaveMessageAsync(
+	message: IMessage,
+	room: IRoom,
+	user: IUser,
+	{
+		roomUpdater: updater,
+		options,
+	}: {
+		roomUpdater?: Updater<IRoom>;
+		options?: SendMessageOptions;
+	} = {},
+): void {
+	const roomUpdater = updater ?? Rooms.getUpdater();
+
+	callbacks.runAsync('afterSaveMessage', message, { room, user, roomUpdater, options });
 
 	if (roomUpdater.hasChanges()) {
 		void Rooms.updateFromUpdater({ _id: room._id }, roomUpdater);

apps/meteor/app/lib/server/lib/sendNotificationsOnMessage.ts

@@ -417,7 +417,13 @@ settings.watch('Troubleshoot_Disable_Notifications', (value) => {
 
 	callbacks.add(
 		'afterSaveMessage',
-		(message, { room }) => sendAllNotifications(message, room),
+		(message, { room, options }) => {
+			if (options?.skipNotifications) {
+				return message;
+			}
+
+			return sendAllNotifications(message, room);
+		},
 		callbacks.priority.LOW,
 		'sendNotificationsOnMessage',
 	);

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, {