[BREAK][ENTERPRISE] Limit presence statuses to 200 concurrent users w…

…hen running monolith to keep performance (#27854)

Co-authored-by: Guilherme Gazzo <guilhermegazzo@gmail.com>
Co-authored-by: Júlia Jaeger Foresti <60678893+juliajforesti@users.noreply.github.com>
Co-authored-by: Rodrigo Nascimento <rodrigoknascimento@gmail.com>

apps/meteor/.meteor/packages

@@ -45,7 +45,6 @@ rocketchat:livechat
 rocketchat:streamer
 rocketchat:version
 
-konecty:multiple-instances-status
 konecty:user-presence
 
 dispatch:run-as-user

apps/meteor/.meteor/versions

@@ -60,7 +60,6 @@ jparker:crypto-md5@0.1.1
 jparker:gravatar@0.5.1
 jquery@3.0.0
 kadira:flow-router@2.12.1
-konecty:multiple-instances-status@1.1.0
 konecty:user-presence@2.6.3
 launch-screen@1.3.0
 littledata:synced-cron@1.5.1

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

@@ -27,6 +27,7 @@ import './v1/import';
 import './v1/ldap';
 import './v1/misc';
 import './v1/permissions';
+import './v1/presence';
 import './v1/push';
 import './v1/roles';
 import './v1/rooms.js';

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

@@ -0,0 +1,27 @@
+import { Presence } from '@rocket.chat/core-services';
+
+import { API } from '../api';
+
+API.v1.addRoute(
+	'presence.getConnections',
+	{ authRequired: true, permissionsRequired: ['manage-user-status'] },
+	{
+		async get() {
+			const result = await Presence.getConnectionCount();
+
+			return API.v1.success(result);
+		},
+	},
+);
+
+API.v1.addRoute(
+	'presence.enableBroadcast',
+	{ authRequired: true, permissionsRequired: ['manage-user-status'], twoFactorRequired: true },
+	{
+		async post() {
+			await Presence.toggleBroadcast(true);
+
+			return API.v1.success();
+		},
+	},
+);

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

@@ -775,6 +775,14 @@ API.v1.addRoute(
 	{ authRequired: true },
 	{
 		get() {
+			// if presence broadcast is disabled, return an empty array (all users are "offline")
+			if (settings.get('Presence_broadcast_disabled')) {
+				return API.v1.success({
+					users: [],
+					full: true,
+				});
+			}
+
 			const { from, ids } = this.queryParams;
 
 			const options = {

apps/meteor/app/apps/server/storage/logs-storage.js

@@ -1,6 +1,6 @@
 import { AppConsole } from '@rocket.chat/apps-engine/server/logging';
 import { AppLogStorage } from '@rocket.chat/apps-engine/server/storage';
-import { InstanceStatus } from 'meteor/konecty:multiple-instances-status';
+import { InstanceStatus } from '@rocket.chat/instance-status';
 
 export class AppRealLogsStorage extends AppLogStorage {
 	constructor(model) {

apps/meteor/app/file-upload/server/lib/proxy.js

@@ -4,7 +4,8 @@ import URL from 'url';
 import { Meteor } from 'meteor/meteor';
 import { WebApp } from 'meteor/webapp';
 import { UploadFS } from 'meteor/jalik:ufs';
-import { InstanceStatus } from 'meteor/konecty:multiple-instances-status';
+import { InstanceStatus } from '@rocket.chat/instance-status';
+import { InstanceStatus as InstanceStatusModel } from '@rocket.chat/models';
 
 import { Logger } from '../../../logger';
 import { isDocker } from '../../../utils';
@@ -63,7 +64,7 @@ WebApp.connectHandlers.stack.unshift({
 		}
 
 		// Proxy to other instance
-		const instance = InstanceStatus.getCollection().findOne({ _id: file.instanceId });
+		const instance = Promise.await(InstanceStatusModel.findOneById(file.instanceId));
 
 		if (instance == null) {
 			res.writeHead(404);

apps/meteor/app/lib/server/lib/debug.js

@@ -1,6 +1,6 @@
 import { Meteor } from 'meteor/meteor';
 import { WebApp } from 'meteor/webapp';
-import { InstanceStatus } from 'meteor/konecty:multiple-instances-status';
+import { InstanceStatus } from '@rocket.chat/instance-status';
 import _ from 'underscore';
 
 import { settings } from '../../../settings/server';

apps/meteor/app/lib/server/startup/settings.ts

@@ -3186,10 +3186,20 @@ settingsRegistry.addGroup('Troubleshoot', function () {
 		type: 'boolean',
 		alert: 'Troubleshoot_Disable_Notifications_Alert',
 	});
+
+	// this settings will let clients know in case presence has been disabled
+	this.add('Presence_broadcast_disabled', false, {
+		type: 'boolean',
+		public: true,
+		blocked: true,
+	});
+
 	this.add('Troubleshoot_Disable_Presence_Broadcast', false, {
 		type: 'boolean',
 		alert: 'Troubleshoot_Disable_Presence_Broadcast_Alert',
+		enableQuery: { _id: 'Presence_broadcast_disabled', value: false },
 	});
+
 	this.add('Troubleshoot_Disable_Instance_Broadcast', false, {
 		type: 'boolean',
 		alert: 'Troubleshoot_Disable_Instance_Broadcast_Alert',

apps/meteor/app/notifications/client/lib/Presence.ts

@@ -3,7 +3,7 @@ import { Meteor } from 'meteor/meteor';
 import { Presence, STATUS_MAP } from '../../../../client/lib/presence';
 
 // TODO implement API on Streamer to be able to listen to all streamed data
-// this is a hacky way to listen to all streamed data from user-presense Streamer
+// this is a hacky way to listen to all streamed data from user-presence Streamer
 (Meteor as any).StreamerCentral.on('stream-user-presence', (uid: string, args: unknown) => {
 	if (!Array.isArray(args)) {
 		throw new Error('Presence event must be an array');

apps/meteor/client/hooks/usePresence.ts

@@ -5,6 +5,7 @@ import type { UserPresence } from '../lib/presence';
 import { Presence } from '../lib/presence';
 
 /**
+ * @deprecated
  * Hook to fetch and subscribe users presence
  *
  * @param uid - User Id

apps/meteor/client/hooks/useUserData.ts

@@ -13,19 +13,6 @@ import type { UserPresence } from '../lib/presence';
  */
 export const useUserData = (uid: string): UserPresence | undefined => {
 	const userPresence = useContext(UserPresenceContext);
-	// const subscription = useCallback(
-	// 	(callback: () => void): (() => void) => {
-	// 		Presence.listen(uid, callback);
-	// 		return (): void => {
-	// 			Presence.stop(uid, callback);
-	// 		};
-	// 	},
-	// 	[uid],
-	// );
-
-	// const getSnapshot = (): UserPresence | undefined => Presence.store.get(uid);
-
-	// return useSyncExternalStore(subscription, getSnapshot);
 
 	const { subscribe, get } = useMemo(
 		() => userPresence?.queryUserData(uid) ?? { subscribe: () => () => undefined, get: () => undefined },

apps/meteor/client/lib/presence.ts

@@ -6,7 +6,7 @@ import { Meteor } from 'meteor/meteor';
 
 import { APIClient } from '../../app/utils/client';
 
-export const STATUS_MAP = [UserStatus.OFFLINE, UserStatus.ONLINE, UserStatus.AWAY, UserStatus.BUSY];
+export const STATUS_MAP = [UserStatus.OFFLINE, UserStatus.ONLINE, UserStatus.AWAY, UserStatus.BUSY, UserStatus.DISABLED];
 
 type InternalEvents = {
 	remove: IUser['_id'];
@@ -35,7 +35,7 @@ const uids = new Set<UserPresence['_id']>();
 
 const update: EventHandlerOf<ExternalEvents, string> = (update) => {
 	if (update?._id) {
-		store.set(update._id, { ...store.get(update._id), ...update });
+		store.set(update._id, { ...store.get(update._id), ...update, ...(status === 'disabled' && { status: UserStatus.DISABLED }) });
 		uids.delete(update._id);
 	}
 };
@@ -175,7 +175,16 @@ const get = async (uid: UserPresence['_id']): Promise<UserPresence | undefined>
 		listen(uid, callback);
 	});
 
+let status = 'enabled';
+
+const setStatus = (newStatus: 'enabled' | 'disabled'): void => {
+	status = newStatus;
+	reset();
+};
+
 export const Presence = {
+	setStatus,
+	status,
 	listen,
 	stop,
 	reset,

apps/meteor/client/providers/UserPresenceProvider.tsx

@@ -1,5 +1,6 @@
+import { useSetting } from '@rocket.chat/ui-contexts';
 import type { ReactElement, ReactNode } from 'react';
-import React, { useMemo } from 'react';
+import React, { useMemo, useEffect } from 'react';
 
 import { UserPresenceContext } from '../contexts/UserPresenceContext';
 import { Presence } from '../lib/presence';
@@ -9,6 +10,12 @@ type UserPresenceProviderProps = {
 };
 
 const UserPresenceProvider = ({ children }: UserPresenceProviderProps): ReactElement => {
+	const usePresenceDisabled = useSetting<boolean>('Presence_broadcast_disabled');
+
+	useEffect(() => {
+		Presence.setStatus(usePresenceDisabled ? 'disabled' : 'enabled');
+	}, [usePresenceDisabled]);
+
 	return (
 		<UserPresenceContext.Provider
 			value={useMemo(

apps/meteor/client/sidebar/Sidebar.tsx

@@ -1,16 +1,20 @@
 import { css } from '@rocket.chat/css-in-js';
 import { Box, Palette } from '@rocket.chat/fuselage';
-import { useLayout, useUserPreference } from '@rocket.chat/ui-contexts';
+import { useSessionStorage } from '@rocket.chat/fuselage-hooks';
+import { useLayout, useSetting, useUserPreference } from '@rocket.chat/ui-contexts';
 import React from 'react';
 
 import SidebarRoomList from './RoomList';
 import SidebarFooter from './footer';
 import SidebarHeader from './header';
+import StatusDisabledSection from './sections/StatusDisabledSection';
 
 const Sidebar = () => {
 	const sidebarViewMode = useUserPreference('sidebarViewMode');
 	const sidebarHideAvatar = !useUserPreference('sidebarDisplayAvatar');
 	const { isMobile, sidebar } = useLayout();
+	const [bannerDismissed, setBannerDismissed] = useSessionStorage('presence_cap_notifier', false);
+	const presenceDisabled = useSetting<boolean>('Presence_broadcast_disabled');
 
 	const sideBarBackground = css`
 		background-color: ${Palette.surface['surface-tint']};
@@ -98,6 +102,7 @@ const Sidebar = () => {
 					data-qa-opened={sidebar.isCollapsed ? 'false' : 'true'}
 				>
 					<SidebarHeader />
+					{presenceDisabled && !bannerDismissed && <StatusDisabledSection onDismiss={() => setBannerDismissed(true)} />}
 					<SidebarRoomList />
 					<SidebarFooter />
 				</Box>

apps/meteor/client/sidebar/header/UserDropdown.tsx

@@ -12,14 +12,16 @@ import {
 	RadioButton,
 } from '@rocket.chat/fuselage';
 import { useMutableCallback } from '@rocket.chat/fuselage-hooks';
-import { useLayout, useRoute, useLogout, useSetting, useTranslation } from '@rocket.chat/ui-contexts';
+import type { TranslationKey } from '@rocket.chat/ui-contexts';
+import { useLayout, useRoute, useLogout, useSetting, useTranslation, useSetModal } from '@rocket.chat/ui-contexts';
 import { useThemeMode } from '@rocket.chat/ui-theming/src/hooks/useThemeMode';
 import type { ReactElement } from 'react';
 import React from 'react';
 
 import { AccountBox } from '../../../app/ui-utils/client';
 import { userStatus } from '../../../app/user-status/client';
 import { callbacks } from '../../../lib/callbacks';
+import GenericModal from '../../components/GenericModal';
 import MarkdownText from '../../components/MarkdownText';
 import { UserStatus } from '../../components/UserStatus';
 import UserAvatar from '../../components/avatar/UserAvatar';
@@ -38,7 +40,7 @@ const setStatus = (status: typeof userStatus.list['']): void => {
 
 const translateStatusName = (t: ReturnType<typeof useTranslation>, status: typeof userStatus.list['']): string => {
 	if (isDefaultStatusName(status.name, status.id)) {
-		return t(status.name);
+		return t(status.name as TranslationKey);
 	}
 
 	return status.name;
@@ -52,9 +54,18 @@ type UserDropdownProps = {
 const UserDropdown = ({ user, onClose }: UserDropdownProps): ReactElement => {
 	const t = useTranslation();
 	const accountRoute = useRoute('account-index');
+	const userStatusRoute = useRoute('user-status');
 	const logout = useLogout();
 	const { isMobile } = useLayout();
+	const presenceDisabled = useSetting<boolean>('Presence_broadcast_disabled');
 
+	const setModal = useSetModal();
+	const closeModal = useMutableCallback(() => setModal());
+	const handleGoToSettings = useMutableCallback(() => {
+		userStatusRoute.push({});
+		closeModal();
+		onClose();
+	});
 	const [selectedTheme, setTheme] = useThemeMode();
 
 	const { username, avatarETag, status, statusText } = user;
@@ -103,14 +114,40 @@ const UserDropdown = ({ user, onClose }: UserDropdownProps): ReactElement => {
 						<MarkdownText
 							withTruncatedText
 							parseEmoji={true}
-							content={statusText || t(status || 'offline')}
+							content={statusText || t(status ?? 'offline')}
 							variant='inlineWithoutBreaks'
 						/>
 					</Box>
 				</Box>
 			</Box>
 			<OptionDivider />
 			<OptionTitle>{t('Status')}</OptionTitle>
+			{presenceDisabled && (
+				<Box fontScale='p2' mi='x12' mb='x4'>
+					<Box mbe='x4'>{t('User_status_disabled')}</Box>
+					<Box
+						is='a'
+						color='status-font-on-info'
+						onClick={() =>
+							setModal(
+								<GenericModal
+									title={t('User_status_disabled_learn_more')}
+									cancelText={t('Close')}
+									confirmText={t('Go_to_workspace_settings')}
+									children={t('User_status_disabled_learn_more_description')}
+									onConfirm={handleGoToSettings}
+									onClose={closeModal}
+									onCancel={closeModal}
+									icon={null}
+									variant='warning'
+								/>,
+							)
+						}
+					>
+						{t('Learn_more')}
+					</Box>
+				</Box>
+			)}
 			{Object.values(userStatus.list)
 				.filter(filterInvisibleStatus)
 				.map((status, i) => {
@@ -120,6 +157,7 @@ const UserDropdown = ({ user, onClose }: UserDropdownProps): ReactElement => {
 					return (
 						<Option
 							key={i}
+							disabled={presenceDisabled}
 							onClick={(): void => {
 								setStatus(status);
 								onClose();
@@ -134,7 +172,7 @@ const UserDropdown = ({ user, onClose }: UserDropdownProps): ReactElement => {
 						</Option>
 					);
 				})}
-			<Option icon='emoji' label={`${t('Custom_Status')}...`} onClick={handleCustomStatus}></Option>
+			<Option icon='emoji' label={`${t('Custom_Status')}...`} onClick={handleCustomStatus} disabled={presenceDisabled}></Option>
 			<OptionDivider />
 
 			<OptionTitle>{t('Theme')}</OptionTitle>

apps/meteor/client/sidebar/sections/StatusDisabledSection.tsx

@@ -0,0 +1,42 @@
+import { SidebarBanner } from '@rocket.chat/fuselage';
+import { useMutableCallback } from '@rocket.chat/fuselage-hooks';
+import { useRoute, useSetModal, useTranslation } from '@rocket.chat/ui-contexts';
+import React from 'react';
+
+import GenericModal from '../../components/GenericModal';
+
+const StatusDisabledSection = ({ onDismiss }: { onDismiss: () => void }) => {
+	const t = useTranslation();
+	const userStatusRoute = useRoute('user-status');
+	const setModal = useSetModal();
+	const closeModal = useMutableCallback(() => setModal());
+	const handleGoToSettings = useMutableCallback(() => {
+		userStatusRoute.push({});
+		closeModal();
+	});
+
+	return (
+		<SidebarBanner
+			text={t('User_status_temporarily_disabled')}
+			description={t('Learn_more')}
+			onClose={onDismiss}
+			onClick={() =>
+				setModal(
+					<GenericModal
+						title={t('User_status_disabled_learn_more')}
+						cancelText={t('Close')}
+						confirmText={t('Go_to_workspace_settings')}
+						children={t('User_status_disabled_learn_more_description')}
+						onConfirm={handleGoToSettings}
+						onClose={closeModal}
+						onCancel={closeModal}
+						icon={null}
+						variant='warning'
+					/>,
+				)
+			}
+		/>
+	);
+};
+
+export default StatusDisabledSection;