chore: accept additional push tokens intended for voip to iOS devices (RocketChat#39174)

Author: pierre-lehnen-rc

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

@@ -1,5 +1,5 @@
 import { Push } from '@rocket.chat/core-services';
-import type { IPushToken } 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 {
 	ajv,
@@ -23,9 +23,10 @@ import type { SuccessResult } from '../definition';
 
 type PushTokenPOST = {
 	id?: string;
-	type: 'apn' | 'gcm';
+	type: IPushTokenTypes;
 	value: string;
 	appName: string;
+	voipToken?: string;
 };
 
 const PushTokenPOSTSchema: JSONSchemaType<PushTokenPOST> = {
@@ -47,6 +48,10 @@ const PushTokenPOSTSchema: JSONSchemaType<PushTokenPOST> = {
 			type: 'string',
 			minLength: 1,
 		},
+		voipToken: {
+			type: 'string',
+			nullable: true,
+		},
 	},
 	required: ['type', 'value', 'appName'],
 	additionalProperties: false,
@@ -72,13 +77,13 @@ const PushTokenDELETESchema: JSONSchemaType<PushTokenDELETE> = {
 
 export const isPushTokenDELETEProps = ajv.compile<PushTokenDELETE>(PushTokenDELETESchema);
 
-type PushTokenResult = Pick<IPushToken, '_id' | 'token' | 'appName' | 'userId' | 'enabled' | 'createdAt' | '_updatedAt'>;
+type PushTokenResult = Pick<IPushToken, '_id' | 'token' | 'appName' | 'userId' | 'enabled' | 'createdAt' | '_updatedAt' | 'voipToken'>;
 
 /**
  * Pick only the attributes we actually want to return on the endpoint, ensuring nothing from older schemas get mixed in
  */
 function cleanTokenResult(result: Omit<IPushToken, 'authToken'>): PushTokenResult {
-	const { _id, token, appName, userId, enabled, createdAt, _updatedAt } = result;
+	const { _id, token, appName, userId, enabled, createdAt, _updatedAt, voipToken } = result;
 
 	return {
 		_id,
@@ -88,6 +93,7 @@ function cleanTokenResult(result: Omit<IPushToken, 'authToken'>): PushTokenResul
 		enabled,
 		createdAt,
 		_updatedAt,
+		voipToken,
 	};
 }
 
@@ -140,6 +146,9 @@ const pushTokenEndpoints = API.v1
 								_updatedAt: {
 									type: 'string',
 								},
+								voipToken: {
+									type: 'string',
+								},
 							},
 							additionalProperties: false,
 						},
@@ -154,7 +163,11 @@ const pushTokenEndpoints = API.v1
 			authRequired: true,
 		},
 		async function action() {
-			const { id, type, value, appName } = this.bodyParams;
+			const { id, type, value, appName, voipToken } = this.bodyParams;
+
+			if (voipToken && !id) {
+				return API.v1.failure('voip-tokens-must-specify-device-id');
+			}
 
 			const rawToken = this.request.headers.get('x-auth-token');
 			if (!rawToken) {
@@ -168,6 +181,7 @@ const pushTokenEndpoints = API.v1
 				authToken,
 				appName,
 				userId: this.userId,
+				...(voipToken && { voipToken }),
 			});
 
 			return API.v1.success({ result: cleanTokenResult(result) });

apps/meteor/server/services/push/service.ts

@@ -36,7 +36,12 @@ export class PushService extends ServiceClassInternal implements IPushService {
 	): Promise<Omit<IPushToken, 'authToken'>> {
 		const tokenId = await registerPushToken(data);
 
-		const removeResult = await PushToken.removeByTokenAndAppNameExceptId(data.token, data.appName, tokenId);
+		const removeResult = await PushToken.removeDuplicateTokens({
+			_id: tokenId,
+			token: data.token,
+			appName: data.appName,
+			authToken: data.authToken,
+		});
 		if (removeResult.deletedCount) {
 			logger.debug({ msg: 'Removed existing app items', removed: removeResult.deletedCount });
 		}

apps/meteor/server/services/push/tokenManagement/findDocumentToUpdate.ts

@@ -9,6 +9,11 @@ export async function findDocumentToUpdate(data: Partial<IPushToken>): Promise<I
 		}
 	}
 
+	// VoIP tokens MUST match the id
+	if (data.voipToken) {
+		return null;
+	}
+
 	if (data.token && data.appName) {
 		return PushToken.findOneByTokenAndAppName(data.token, data.appName);
 	}

apps/meteor/server/services/push/tokenManagement/registerPushToken.ts

@@ -1,35 +1,52 @@
 import type { IPushToken, Optional } from '@rocket.chat/core-typings';
 import { PushToken } from '@rocket.chat/models';
 
-import { logger } from '../logger';
 import { findDocumentToUpdate } from './findDocumentToUpdate';
+import { logger } from '../logger';
 
-export async function registerPushToken(
-	data: Optional<Pick<IPushToken, '_id' | 'token' | 'authToken' | 'appName' | 'userId' | 'metadata'>, '_id' | 'metadata'>,
-): Promise<IPushToken['_id']> {
-	const doc = await findDocumentToUpdate(data);
-
-	if (!doc) {
-		const insertResult = await PushToken.insertToken({
-			...(data._id && { _id: data._id }),
-			token: data.token,
-			authToken: data.authToken,
-			appName: data.appName,
-			userId: data.userId,
-			...(data.metadata && { metadata: data.metadata }),
-		});
+export type PushTokenData = Optional<
+	Pick<IPushToken, '_id' | 'token' | 'authToken' | 'appName' | 'userId' | 'metadata' | 'voipToken'>,
+	'_id' | 'metadata'
+>;
 
-		const { authToken: _, ...dataWithNoAuthToken } = data;
-		logger.debug({ msg: 'Push token added', dataWithNoAuthToken, insertResult });
+function canModifyTokenDocument(doc: IPushToken, data: Partial<IPushToken>): boolean {
+	// If there's no voip on either side of the operation, any doc can be updated
+	if (!doc.voipToken && !data.voipToken) {
+		return true;
+	}
 
-		return insertResult.insertedId;
+	// VoIP tokens MUST be referenced by id, so if there's no id on the data, do not let this doc be changed
+	if (!data._id || data._id !== doc._id) {
+		return false;
 	}
 
+	return true;
+}
+
+async function insertToken(data: PushTokenData): Promise<IPushToken['_id']> {
+	const insertResult = await PushToken.insertToken({
+		...(data._id && { _id: data._id }),
+		token: data.token,
+		authToken: data.authToken,
+		appName: data.appName,
+		userId: data.userId,
+		...(data.metadata && { metadata: data.metadata }),
+		...(data.voipToken && data._id && { voipToken: data.voipToken }),
+	});
+
+	const { authToken: _, ...dataWithNoAuthToken } = data;
+	logger.debug({ msg: 'Push token added', dataWithNoAuthToken, insertResult });
+
+	return insertResult.insertedId;
+}
+
+async function updateToken(doc: IPushToken, data: PushTokenData): Promise<IPushToken['_id']> {
 	const updateResult = await PushToken.refreshTokenById(doc._id, {
 		token: data.token,
 		authToken: data.authToken,
 		appName: data.appName,
 		userId: data.userId,
+		...(data.voipToken && { voipToken: data.voipToken }),
 	});
 
 	if (updateResult.modifiedCount) {
@@ -39,3 +56,13 @@ export async function registerPushToken(
 
 	return doc._id;
 }
+
+export async function registerPushToken(data: PushTokenData): Promise<IPushToken['_id']> {
+	const doc = await findDocumentToUpdate(data);
+
+	if (!doc || !canModifyTokenDocument(doc, data)) {
+		return insertToken(data);
+	}
+
+	return updateToken(doc, data);
+}

packages/core-typings/src/IPushToken.ts

@@ -11,4 +11,5 @@ export interface IPushToken extends IRocketChatRecord {
 	authToken: ILoginToken['hashedToken'];
 	metadata?: Record<string, unknown>;
 	createdAt: Date;
+	voipToken?: string;
 }

packages/model-typings/src/models/IPushTokenModel.ts

@@ -13,11 +13,11 @@ export interface IPushTokenModel extends IBaseModel<IPushToken> {
 	insertToken(data: AtLeast<IPushToken, 'token' | 'authToken' | 'appName' | 'userId'>): Promise<InsertOneResult<IPushToken>>;
 	refreshTokenById(
 		id: IPushToken['_id'],
-		data: Pick<IPushToken, 'token' | 'appName' | 'authToken' | 'userId'>,
+		data: Pick<IPushToken, 'token' | 'appName' | 'authToken' | 'userId' | 'voipToken'>,
 	): Promise<UpdateResult<IPushToken>>;
 
 	removeByUserIdExceptTokens(userId: string, tokens: IPushToken['authToken'][]): Promise<DeleteResult>;
-	removeByTokenAndAppNameExceptId(token: IPushToken['token'], appName: IPushToken['appName'], id: IPushToken['_id']): Promise<DeleteResult>;
+	removeDuplicateTokens(tokenData: Pick<IPushToken, '_id' | 'token' | 'appName' | 'authToken'>): Promise<DeleteResult>;
 
 	removeAllByUserId(userId: string): Promise<DeleteResult>;
 	removeAllByTokenStringAndUserId(token: string, userId: string): Promise<DeleteResult>;

packages/models/src/models/PushToken.ts

@@ -56,7 +56,7 @@ export class PushTokenRaw extends BaseRaw<IPushToken> implements IPushTokenModel
 
 	async refreshTokenById(
 		id: IPushToken['_id'],
-		data: Pick<IPushToken, 'token' | 'appName' | 'authToken' | 'userId'>,
+		data: Pick<IPushToken, 'token' | 'appName' | 'authToken' | 'userId' | 'voipToken'>,
 	): Promise<UpdateResult<IPushToken>> {
 		return this.updateOne(
 			{ _id: id },
@@ -66,7 +66,9 @@ export class PushTokenRaw extends BaseRaw<IPushToken> implements IPushTokenModel
 					authToken: data.authToken,
 					appName: data.appName,
 					userId: data.userId,
+					...(data.voipToken && { voipToken: data.voipToken }),
 				},
+				...(!data.voipToken && { $unset: { voipToken: 1 } }),
 			},
 		);
 	}
@@ -85,15 +87,18 @@ export class PushTokenRaw extends BaseRaw<IPushToken> implements IPushTokenModel
 		});
 	}
 
-	removeByTokenAndAppNameExceptId(
-		token: IPushToken['token'],
-		appName: IPushToken['appName'],
-		id: IPushToken['_id'],
-	): Promise<DeleteResult> {
+	removeDuplicateTokens(tokenData: Pick<IPushToken, '_id' | 'token' | 'appName' | 'authToken'>): Promise<DeleteResult> {
 		return this.deleteMany({
-			token,
-			appName,
-			_id: { $ne: id },
+			_id: { $ne: tokenData._id },
+			$or: [
+				{
+					token: tokenData.token,
+					appName: tokenData.appName,
+				},
+				{
+					authToken: tokenData.authToken,
+				},
+			],
 		});
 	}