chore: device management improve readability and performance

apps/meteor/ee/server/lib/deviceManagement/session.ts

@@ -1,14 +1,13 @@
 import { Meteor } from 'meteor/meteor';
 import { Accounts } from 'meteor/accounts-base';
 import { UAParser } from 'ua-parser-js';
-import type { ISocketConnection, IUser } from '@rocket.chat/core-typings';
+import type { ISocketConnection } from '@rocket.chat/core-typings';
 import { Users } from '@rocket.chat/models';
 
 import * as Mailer from '../../../../app/mailer/server/api';
 import { settings } from '../../../../app/settings/server';
 import { UAParserDesktop, UAParserMobile } from '../../../../app/statistics/server/lib/UAParserCustom';
 import { deviceManagementEvents } from '../../../../server/services/device-management/events';
-import { hasLicense } from '../../../app/license/server/license';
 import { getUserPreference } from '../../../../app/utils/server';
 import { t } from '../../../../app/utils/lib/i18n';
 
@@ -23,88 +22,97 @@ Meteor.startup(() => {
 const uaParser = async (
 	uaString: ISocketConnection['httpHeaders']['user-agent'],
 ): Promise<UAParser.IResult & { app?: { name: string; version: string; bundle: string } }> => {
-	let rcAgent = {};
-	if (uaString && UAParserMobile.isMobileApp(uaString)) {
-		rcAgent = UAParserMobile.uaObject(uaString);
-	}
-
-	if (uaString && UAParserDesktop.isDesktopApp(uaString)) {
-		rcAgent = UAParserDesktop.uaObject(uaString);
-	}
-
 	const ua = new UAParser(uaString);
-	return { ...ua.getResult(), ...rcAgent };
+	return {
+		...ua.getResult(),
+		...(uaString && UAParserMobile.isMobileApp(uaString) && UAParserMobile.uaObject(uaString)),
+		...(uaString && UAParserDesktop.isDesktopApp(uaString) && UAParserDesktop.uaObject(uaString)),
+	};
 };
 
-export const listenSessionLogin = async (): Promise<void> => {
-	deviceManagementEvents.on('device-login', async ({ userId, connection }) => {
-		if (!hasLicense('device-management')) return;
+export const listenSessionLogin = () => {
+	return deviceManagementEvents.on('device-login', async ({ userId, connection }) => {
+		const deviceEnabled = settings.get('Device_Management_Enable_Login_Emails');
+
+		if (!deviceEnabled) {
+			return;
+		}
+
+		if (connection.loginToken) {
+			return;
+		}
+
+		const user = await Users.findOneByIdWithEmailAddress(userId, {
+			projection: { 'name': 1, 'username': 1, 'emails': 1, 'settings.preferences.receiveLoginDetectionEmail': 1 },
+		});
+
+		if (!user?.emails?.length) {
+			return;
+		}
+
+		const userReceiveLoginEmailPreference =
+			!settings.get('Device_Management_Allow_Login_Email_preference') ||
+			(await getUserPreference(userId, 'receiveLoginDetectionEmail', true));
 
-		const user = await Users.findOneById<IUser>(userId, { projection: { name: 1, username: 1, emails: 1 } });
-		if (user?.emails?.length && !connection.loginToken) {
-			const {
-				name,
-				username,
-				emails: [{ address: email }],
-			} = user;
-			const { browser, os, device, cpu, app } = await uaParser(connection.httpHeaders['user-agent']);
+		if (!userReceiveLoginEmailPreference) {
+			return;
+		}
 
-			const mailData = {
-				name,
-				username,
-				browserInfo: `${browser.name} ${browser.version}`,
-				osInfo: `${os.name}`,
-				deviceInfo: `${device.type || t('Device_Management_Device_Unknown')} ${device.vendor || ''} ${device.model || ''} ${
-					cpu.architecture || ''
-				}`,
-				ipInfo: connection.clientAddress,
-				userAgent: '',
-			};
+		const {
+			name,
+			username,
+			emails: [{ address: email }],
+		} = user;
+		const { browser, os, device, cpu, app } = await uaParser(connection.httpHeaders['user-agent']);
 
-			switch (device.type) {
-				case 'mobile':
-				case 'tablet':
-				case 'smarttv':
-					mailData.browserInfo = `${browser.name} ${browser.version}`;
-					mailData.osInfo = `${os.name}`;
-					mailData.deviceInfo = `${device.type} ${device.vendor || ''} ${device.model || ''} ${cpu.architecture || ''}`;
-					break;
-				case 'mobile-app':
-					mailData.browserInfo = `Rocket.Chat App ${app?.bundle || app?.version}`;
-					mailData.osInfo = `${os.name}`;
-					mailData.deviceInfo = 'Mobile App';
-					break;
-				case 'desktop-app':
-					mailData.browserInfo = `Rocket.Chat ${app?.name || browser.name} ${app?.bundle || app?.version || browser.version}`;
-					mailData.osInfo = `${os.name}`;
-					mailData.deviceInfo = `Desktop App ${cpu.architecture || ''}`;
-					break;
-				default:
-					mailData.userAgent = connection.httpHeaders['user-agent'] || '';
-					break;
-			}
+		const mailData = {
+			name,
+			username,
+			browserInfo: `${browser.name} ${browser.version}`,
+			osInfo: `${os.name}`,
+			deviceInfo: `${device.type || t('Device_Management_Device_Unknown')} ${device.vendor || ''} ${device.model || ''} ${
+				cpu.architecture || ''
+			}`,
+			ipInfo: connection.clientAddress,
+			userAgent: '',
+		};
 
-			try {
-				const userReceiveLoginEmailPreference = settings.get('Device_Management_Allow_Login_Email_preference')
-					? await getUserPreference(userId, 'receiveLoginDetectionEmail', true)
-					: true;
-				const shouldSendLoginEmail = settings.get('Device_Management_Enable_Login_Emails') && userReceiveLoginEmailPreference;
+		switch (device.type) {
+			case 'mobile':
+			case 'tablet':
+			case 'smarttv':
+				mailData.browserInfo = `${browser.name} ${browser.version}`;
+				mailData.osInfo = `${os.name}`;
+				mailData.deviceInfo = `${device.type} ${device.vendor || ''} ${device.model || ''} ${cpu.architecture || ''}`;
+				break;
+			case 'mobile-app':
+				mailData.browserInfo = `Rocket.Chat App ${app?.bundle || app?.version}`;
+				mailData.osInfo = `${os.name}`;
+				mailData.deviceInfo = 'Mobile App';
+				break;
+			case 'desktop-app':
+				mailData.browserInfo = `Rocket.Chat ${app?.name || browser.name} ${app?.bundle || app?.version || browser.version}`;
+				mailData.osInfo = `${os.name}`;
+				mailData.deviceInfo = `Desktop App ${cpu.architecture || ''}`;
+				break;
+			default:
+				mailData.userAgent = connection.httpHeaders['user-agent'] || '';
+				break;
+		}
 
-				if (shouldSendLoginEmail) {
-					await Mailer.send({
-						to: `${name} <${email}>`,
-						from: Accounts.emailTemplates.from,
-						subject: settings.get('Device_Management_Email_Subject'),
-						html: mailTemplates,
-						data: mailData,
-					});
-				}
-			} catch ({ message }: any) {
-				throw new Meteor.Error('error-email-send-failed', `Error trying to send email: ${message}`, {
-					method: 'listenSessionLogin',
-					message,
-				});
-			}
+		try {
+			await Mailer.send({
+				to: `${name} <${email}>`,
+				from: Accounts.emailTemplates.from,
+				subject: settings.get('Device_Management_Email_Subject'),
+				html: mailTemplates,
+				data: mailData,
+			});
+		} catch ({ message }: any) {
+			throw new Meteor.Error('error-email-send-failed', `Error trying to send email: ${message}`, {
+				method: 'listenSessionLogin',
+				message,
+			});
 		}
 	});
 };

apps/meteor/ee/server/startup/deviceManagement.ts

@@ -1,6 +1,7 @@
 import { onToggledFeature } from '../../app/license/server/license';
 import { addSettings } from '../settings/deviceManagement';
 
+let stopListening: (() => void) | undefined;
 onToggledFeature('device-management', {
 	up: async () => {
 		const { createPermissions, createEmailTemplates } = await import('../lib/deviceManagement/startup');
@@ -9,6 +10,10 @@ onToggledFeature('device-management', {
 		await addSettings();
 		await createPermissions();
 		await createEmailTemplates();
-		await listenSessionLogin();
+		stopListening = await listenSessionLogin();
+	},
+	down: async () => {
+		stopListening?.();
+		stopListening = undefined;
 	},
 });

apps/meteor/server/models/raw/Users.js

@@ -1250,6 +1250,16 @@ export class UsersRaw extends BaseRaw {
 		return this.findOne({ 'services.password.reset.token': token }, options);
 	}
 
+	findOneByIdWithEmailAddress(userId, options) {
+		return this.findOne(
+			{
+				_id: userId,
+				emails: { $exists: true, $ne: [] },
+			},
+			options,
+		);
+	}
+
 	setFederationAvatarUrlById(userId, federationAvatarUrl) {
 		return this.updateOne(
 			{

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

@@ -17,6 +17,7 @@ export interface IUsersModel extends IBaseModel<IUser> {
 	addRolesByUserId(uid: IUser['_id'], roles: IRole['_id'][]): Promise<UpdateResult>;
 	findUsersInRoles<T = IUser>(roles: IRole['_id'][], scope?: null, options?: any): FindCursor<T>;
 	findPaginatedUsersInRoles<T = IUser>(roles: IRole['_id'][], options?: any): FindPaginated<FindCursor<T>>;
+	findOneByIdWithEmailAddress(uid: IUser['_id'], options?: FindOptions<IUser>): Promise<IUser | null>;
 	findOneByUsername<T = IUser>(username: string, options?: any): Promise<T>;
 	findOneAgentById<T = ILivechatAgent>(_id: string, options: any): Promise<T>;
 	findUsersInRolesWithQuery<T = IUser>(roles: IRole['_id'] | IRole['_id'][], query: any, options: any): FindCursor<T>;